pymomentum-cpu 0.1.93.post0__cp312-cp312-macosx_14_0_arm64.whl

include/momentum/common/exception.h

@@ -0,0 +1,70 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <fmt/format.h>
+
+#include <stdexcept>
+
+/// Throws an exception of a specified type with a formatted message.
+/// @param Exception The type of exception to throw.
+/// @param ... The message and format specifiers.
+/// @code
+///   MT_THROW_T(std::invalid_argument, "Invalid argument: {}", arg);
+///   MT_THROW_T(std::bad_array_new_length); // No message
+/// @endcode
+#define MT_THROW_T(Exception, ...) ::momentum::detail::throwImpl<Exception>(__VA_ARGS__)
+
+/// Throws a std::runtime_error with a formatted message.
+/// @param ... The message and format specifiers.
+/// @code
+///   MT_THROW("Error occurred: {}", errorDetail);
+/// @endcode
+#define MT_THROW(...) MT_THROW_T(::momentum::detail::DefaultException, ##__VA_ARGS__)
+
+/// Conditionally throws an exception of a specified type with a formatted message if the condition
+/// is true.
+/// @param Condition The condition to evaluate.
+/// @param Exception The type of exception to throw.
+/// @param ... The message and format specifiers.
+/// @code
+///   MT_THROW_IF_T(x > y, std::out_of_range, "x ({}) is greater than y ({})", x, y);
+///   MT_THROW_IF_T(x > y, std::bad_array_new_length); // No message
+/// @endcode
+#define MT_THROW_IF_T(Condition, Exception, ...) \
+  if (Condition) {                               \
+    MT_THROW_T(Exception, ##__VA_ARGS__);        \
+  }
+
+/// Conditionally throws a std::runtime_error with a formatted message if the condition is true.
+/// @param Condition The condition to evaluate.
+/// @param ... The message and format specifiers.
+/// @code
+///   MT_THROW_IF(x == nullptr, "x cannot be nullptr");
+/// @endcode
+#define MT_THROW_IF(Condition, ...) \
+  MT_THROW_IF_T(Condition, ::momentum::detail::DefaultException, ##__VA_ARGS__)
+
+namespace momentum::detail {
+
+using DefaultException = std::runtime_error;
+
+// Helper function template to throw with formatted message
+template <typename Exception = DefaultException, typename... Args>
+[[noreturn]] void throwImpl(fmt::format_string<Args...> format, Args&&... args) {
+  throw Exception{fmt::format(format, std::forward<Args>(args)...)};
+}
+
+// Overload for throwing exceptions that do not require any message or whose constructors do not
+// take any arguments.
+template <typename Exception>
+[[noreturn]] void throwImpl() {
+  throw Exception{};
+}
+
+} // namespace momentum::detail

include/momentum/common/filesystem.h

@@ -0,0 +1,20 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#if defined(MOMENTUM_WITH_PORTABILITY)
+
+#include <portability/Filesystem.h>
+
+#else
+
+#include <filesystem>
+
+namespace filesystem = std::filesystem;
+
+#endif

include/momentum/common/fwd.h

@@ -0,0 +1,27 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+// This file is @generated by gen_fwd.py
+// Do not edit this file directly, instead update gen_fwd_input.toml and run:
+// buck run @arvr/mode/platform010/opt //arvr/libraries/momentum:gen_fwd
+
+#pragma once
+
+#include <memory>
+
+namespace momentum {
+
+class ProgressBar;
+
+using ProgressBar_p = ::std::shared_ptr<ProgressBar>;
+using ProgressBar_u = ::std::unique_ptr<ProgressBar>;
+using ProgressBar_w = ::std::weak_ptr<ProgressBar>;
+using ProgressBar_const_p = ::std::shared_ptr<const ProgressBar>;
+using ProgressBar_const_u = ::std::unique_ptr<const ProgressBar>;
+using ProgressBar_const_w = ::std::weak_ptr<const ProgressBar>;
+
+} // namespace momentum

include/momentum/common/log.h

@@ -0,0 +1,173 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#if defined(MOMENTUM_WITH_XR_LOGGER)
+
+// Allow DEFAULT_LOG_CHANNEL to be defined before including this file if you want to override the
+// default channel name. To set your own channel name (the order matters):
+//   #define DEFAULT_LOG_CHANNEL "my_custom_channel_name"
+//   #include <momentum/common/logging.h>
+#ifndef DEFAULT_LOG_CHANNEL
+#include <momentum/common/log_channel.h>
+#define DEFAULT_LOG_CHANNEL MOMENTUM_LOG_CHANNEL
+#endif
+
+#include <logging/Log.h>
+
+#define MT_LOGT(...) XR_LOGT(__VA_ARGS__)
+#define MT_LOGD(...) XR_LOGD(__VA_ARGS__)
+#define MT_LOGI(...) XR_LOGI(__VA_ARGS__)
+#define MT_LOGW(...) XR_LOGW(__VA_ARGS__)
+#define MT_LOGE(...) XR_LOGE(__VA_ARGS__)
+
+#define MT_LOGT_IF(condition, ...) XR_LOGT_IF(condition, __VA_ARGS__)
+#define MT_LOGD_IF(condition, ...) XR_LOGD_IF(condition, __VA_ARGS__)
+#define MT_LOGI_IF(condition, ...) XR_LOGI_IF(condition, __VA_ARGS__)
+#define MT_LOGW_IF(condition, ...) XR_LOGW_IF(condition, __VA_ARGS__)
+#define MT_LOGE_IF(condition, ...) XR_LOGE_IF(condition, __VA_ARGS__)
+
+#define MT_LOGT_ONCE(...) XR_LOGT_ONCE(__VA_ARGS__)
+#define MT_LOGD_ONCE(...) XR_LOGD_ONCE(__VA_ARGS__)
+#define MT_LOGI_ONCE(...) XR_LOGI_ONCE(__VA_ARGS__)
+#define MT_LOGW_ONCE(...) XR_LOGW_ONCE(__VA_ARGS__)
+#define MT_LOGE_ONCE(...) XR_LOGE_ONCE(__VA_ARGS__)
+
+#define MT_LOGT_ONCE_IF(condition, ...) XR_LOGT_ONCE_IF(condition, __VA_ARGS__)
+#define MT_LOGD_ONCE_IF(condition, ...) XR_LOGD_ONCE_IF(condition, __VA_ARGS__)
+#define MT_LOGI_ONCE_IF(condition, ...) XR_LOGI_ONCE_IF(condition, __VA_ARGS__)
+#define MT_LOGW_ONCE_IF(condition, ...) XR_LOGW_ONCE_IF(condition, __VA_ARGS__)
+#define MT_LOGE_ONCE_IF(condition, ...) XR_LOGE_ONCE_IF(condition, __VA_ARGS__)
+
+#elif defined(MOMENTUM_WITH_SPDLOG)
+
+#include <spdlog/spdlog.h>
+
+#include <atomic>
+
+#define MT_LOGT(...) ::spdlog::trace(__VA_ARGS__)
+#define MT_LOGD(...) ::spdlog::debug(__VA_ARGS__)
+#define MT_LOGI(...) ::spdlog::info(__VA_ARGS__)
+#define MT_LOGW(...) ::spdlog::warn(__VA_ARGS__)
+#define MT_LOGE(...) ::spdlog::error(__VA_ARGS__)
+
+#define MT_LOGT_IF(condition, ...) \
+  if (condition) {                 \
+    MT_LOGT(__VA_ARGS__);          \
+  }
+#define MT_LOGD_IF(condition, ...) \
+  if (condition) {                 \
+    MT_LOGD(__VA_ARGS__);          \
+  }
+#define MT_LOGI_IF(condition, ...) \
+  if (condition) {                 \
+    MT_LOGI(__VA_ARGS__);          \
+  }
+#define MT_LOGW_IF(condition, ...) \
+  if (condition) {                 \
+    MT_LOGW(__VA_ARGS__);          \
+  }
+#define MT_LOGE_IF(condition, ...) \
+  if (condition) {                 \
+    MT_LOGE(__VA_ARGS__);          \
+  }
+
+// This function is designed to limit the number of times an error is logged.
+// Please note that in a multi-threaded context, its behavior may not be guaranteed.
+#define _MT_RUN_ONCE(runcode)                                \
+  {                                                          \
+    static std::atomic<bool> codeRan(false);                 \
+    if (!codeRan) {                                          \
+      bool expected = false;                                 \
+      if (codeRan.compare_exchange_strong(expected, true)) { \
+        runcode;                                             \
+      }                                                      \
+    }                                                        \
+  }
+
+#define MT_LOGT_ONCE(...) _MT_RUN_ONCE(MT_LOGT(__VA_ARGS__))
+#define MT_LOGD_ONCE(...) _MT_RUN_ONCE(MT_LOGD(__VA_ARGS__))
+#define MT_LOGI_ONCE(...) _MT_RUN_ONCE(MT_LOGI(__VA_ARGS__))
+#define MT_LOGW_ONCE(...) _MT_RUN_ONCE(MT_LOGW(__VA_ARGS__))
+#define MT_LOGE_ONCE(...) _MT_RUN_ONCE(MT_LOGE(__VA_ARGS__))
+
+#define MT_LOGT_ONCE_IF(condition, ...) \
+  if (condition) {                      \
+    MT_LOGT_ONCE(__VA_ARGS__);          \
+  }
+#define MT_LOGD_ONCE_IF(condition, ...) \
+  if (condition) {                      \
+    MT_LOGD_ONCE(__VA_ARGS__);          \
+  }
+#define MT_LOGI_ONCE_IF(condition, ...) \
+  if (condition) {                      \
+    MT_LOGI_ONCE(__VA_ARGS__);          \
+  }
+#define MT_LOGW_ONCE_IF(condition, ...) \
+  if (condition) {                      \
+    MT_LOGW_ONCE(__VA_ARGS__);          \
+  }
+#define MT_LOGE_ONCE_IF(condition, ...) \
+  if (condition) {                      \
+    MT_LOGE_ONCE(__VA_ARGS__);          \
+  }
+
+#else
+
+#define MT_LOGT(...)
+#define MT_LOGD(...)
+#define MT_LOGI(...)
+#define MT_LOGW(...)
+#define MT_LOGE(...)
+
+#define MT_LOGT_IF(condition, ...)
+#define MT_LOGD_IF(condition, ...)
+#define MT_LOGI_IF(condition, ...)
+#define MT_LOGW_IF(condition, ...)
+#define MT_LOGE_IF(condition, ...)
+
+#define MT_LOGT_ONCE(...)
+#define MT_LOGD_ONCE(...)
+#define MT_LOGI_ONCE(...)
+#define MT_LOGW_ONCE(...)
+#define MT_LOGE_ONCE(...)
+
+#define MT_LOGT_ONCE_IF(condition, ...)
+#define MT_LOGD_ONCE_IF(condition, ...)
+#define MT_LOGI_ONCE_IF(condition, ...)
+#define MT_LOGW_ONCE_IF(condition, ...)
+#define MT_LOGE_ONCE_IF(condition, ...)
+
+#endif
+
+#include <momentum/common/checks.h>
+
+#include <map>
+#include <string>
+
+namespace momentum {
+
+/// Logging levels in descending order of verbosity
+enum class LogLevel {
+  Disabled = 0,
+  Error,
+  Warning,
+  Info,
+  Debug,
+  Trace,
+};
+
+[[nodiscard]] std::map<std::string, LogLevel> logLevelMap();
+
+void setLogLevel(LogLevel level);
+
+void setLogLevel(const std::string& levelStr);
+
+[[nodiscard]] LogLevel getLogLevel();
+
+} // namespace momentum

include/momentum/common/log_channel.h

@@ -0,0 +1,17 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#if defined(MOMENTUM_WITH_XR_LOGGER)
+
+// The file to include in header files. Used as XR_LOGCI(MOMENTUM_LOG_CHANNEL, "message");
+
+#include <logging/Log.h>
+#define MOMENTUM_LOG_CHANNEL "MOMENTUM"
+
+#endif

include/momentum/common/memory.h

@@ -0,0 +1,71 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <memory>
+
+// Define smart pointers for a type
+#ifndef MOMENTUM_DEFINE_POINTERS
+#define MOMENTUM_DEFINE_POINTERS(x)               \
+  using x##_p = ::std::shared_ptr<x>;             \
+  using x##_u = ::std::unique_ptr<x>;             \
+  using x##_w = ::std::weak_ptr<x>;               \
+  using x##_const_p = ::std::shared_ptr<const x>; \
+  using x##_const_u = ::std::unique_ptr<const x>; \
+  using x##_const_w = ::std::weak_ptr<const x>;
+#endif // MOMENTUM_DEFINE_POINTERS
+
+// Forward-declare a struct, define smart pointers
+#ifndef MOMENTUM_FWD_DECLARE_STRUCT
+#define MOMENTUM_FWD_DECLARE_STRUCT(x) \
+  struct x;                            \
+  MOMENTUM_DEFINE_POINTERS(x);
+#endif // MOMENTUM_FWD_DECLARE_STRUCT
+
+// Forward-declare a class, define smart pointers
+#ifndef MOMENTUM_FWD_DECLARE_CLASS
+// NOLINTBEGIN(bugprone-macro-parentheses)
+#define MOMENTUM_FWD_DECLARE_CLASS(x) \
+  class x;                            \
+  MOMENTUM_DEFINE_POINTERS(x)
+// NOLINTEND(bugprone-macro-parentheses)
+#endif // MOMENTUM_FWD_DECLARE_CLASS
+
+// Forward-declare a templated class, define smart pointers for the class and its variants
+// Use the standard backward-compatible naming scheme:
+//    template <typename T> class BarT;
+//    using Bar = BarT<float>;
+//    using Bard = BarT<double>;
+#ifndef MOMENTUM_FWD_DECLARE_TEMPLATE_CLASS
+// NOLINTBEGIN(bugprone-macro-parentheses)
+#define MOMENTUM_FWD_DECLARE_TEMPLATE_CLASS(x) \
+  template <typename T>                        \
+  class x##T;                                  \
+  using x = x##T<float>;                       \
+  using x##d = x##T<double>;                   \
+  MOMENTUM_DEFINE_POINTERS(x)                  \
+  MOMENTUM_DEFINE_POINTERS(x##d)
+// NOLINTEND(bugprone-macro-parentheses)
+#endif // MOMENTUM_FWD_DECLARE_TEMPLATE_CLASS
+
+// Forward-declare a templated struct, define smart pointers for the struct and its variants
+// Use the standard backward-compatible naming scheme:
+//    template <typename T> struct BarT;
+//    using Bar = BarT<float>;
+//    using Bard = BarT<double>;
+#ifndef MOMENTUM_FWD_DECLARE_TEMPLATE_STRUCT
+// NOLINTBEGIN(bugprone-macro-parentheses)
+#define MOMENTUM_FWD_DECLARE_TEMPLATE_STRUCT(x) \
+  template <typename T>                         \
+  struct x##T;                                  \
+  using x = x##T<float>;                        \
+  using x##d = x##T<double>;                    \
+  MOMENTUM_DEFINE_POINTERS(x)                   \
+  MOMENTUM_DEFINE_POINTERS(x##d)
+// NOLINTEND(bugprone-macro-parentheses)
+#endif // MOMENTUM_FWD_DECLARE_TEMPLATE_STRUCT

include/momentum/common/profile.h

@@ -0,0 +1,79 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#if defined(MOMENTUM_WITH_XR_PROFILER)
+
+#include <arvr/libraries/profile_redirect/annotate.hpp>
+
+#define MT_PROFILE_FUNCTION() XR_PROFILE_FUNCTION()
+#define MT_PROFILE_FUNCTION_CATEGORY(CATEGORY) XR_PROFILE_FUNCTION_CATEGORY(CATEGORY)
+#define MT_PROFILE_EVENT(NAME) XR_PROFILE_EVENT(NAME)
+#define MT_PROFILE_EVENT_DYNAMIC(NAME) XR_PROFILE_EVENT_DYNAMIC(NAME)
+#define MT_PROFILE_CATEGORY(NAME, CATEGORY) XR_PROFILE_CATEGORY(NAME, CATEGORY)
+#define MT_PROFILE_PREPARE_PUSH_POP() XR_PROFILE_PREPARE_PUSH_POP()
+#define MT_PROFILE_PUSH(NAME) XR_PROFILE_PUSH(NAME)
+#define MT_PROFILE_POP() XR_PROFILE_POP()
+#define MT_PROFILE_THREAD(THREAD_NAME) XR_PROFILE_THREAD(THREAD_NAME)
+#define MT_PROFILE_UPDATE() XR_PROFILE_UPDATE()
+#define MT_PROFILE_BEGIN_FRAME() XR_PROFILE_BEGIN_FRAME()
+#define MT_PROFILE_END_FRAME() XR_PROFILE_END_FRAME()
+#define MT_PROFILE_METADATA(NAME, DATA) XR_PROFILE_METADATA(NAME, DATA)
+
+#elif defined(MOMENTUM_WITH_TRACY_PROFILER)
+
+#include <tracy/Tracy.hpp>
+#include <tracy/TracyC.h>
+#include <stack>
+
+#define _MT_PROFILE_CONCATENATE_DETAIL(x, y) x##y
+#define _MT_PROFILE_CONCATENATE(x, y) _MT_PROFILE_CONCATENATE_DETAIL(x, y)
+#define _MT_PROFILE_MAKE_UNIQUE(x) _MT_PROFILE_CONCATENATE(x, __LINE__)
+
+#define MT_PROFILE_FUNCTION() ZoneScoped
+#define MT_PROFILE_FUNCTION_CATEGORY(CATEGORY)
+#define MT_PROFILE_EVENT(NAME) ZoneNamedN(_MT_PROFILE_MAKE_UNIQUE(__tracy), NAME, true)
+#define MT_PROFILE_EVENT_DYNAMIC(NAME) ZoneTransientN(_MT_PROFILE_MAKE_UNIQUE(__tracy), NAME, true)
+#define MT_PROFILE_CATEGORY(NAME, CATEGORY)
+#define MT_PROFILE_PREPARE_PUSH_POP() std::stack<TracyCZoneCtx> ___tracy_xr_stack
+#define MT_PROFILE_PUSH(NAME)                                                                    \
+  static const struct ___tracy_source_location_data TracyConcat(                                 \
+      __tracy_source_location, TracyLine) = {NAME, __func__, TracyFile, (uint32_t)TracyLine, 0}; \
+  ___tracy_xr_stack.push(                                                                        \
+      ___tracy_emit_zone_begin(&TracyConcat(__tracy_source_location, TracyLine), true));
+#define MT_PROFILE_POP()                  \
+  TracyCZoneEnd(___tracy_xr_stack.top()); \
+  ___tracy_xr_stack.pop()
+#define MT_PROFILE_THREAD(THREAD_NAME)           \
+  {                                              \
+    /* support both std::string and c strings */ \
+    std::string threadNameStr(THREAD_NAME);      \
+    TracyCSetThreadName(threadNameStr.c_str());  \
+  }
+#define MT_PROFILE_UPDATE()
+#define MT_PROFILE_BEGIN_FRAME() FrameMark
+#define MT_PROFILE_END_FRAME()
+#define MT_PROFILE_METADATA(NAME, DATA)
+
+#else
+
+#define MT_PROFILE_FUNCTION()
+#define MT_PROFILE_FUNCTION_CATEGORY(CATEGORY)
+#define MT_PROFILE_EVENT(NAME)
+#define MT_PROFILE_EVENT_DYNAMIC(NAME)
+#define MT_PROFILE_CATEGORY(NAME, CATEGORY)
+#define MT_PROFILE_PREPARE_PUSH_POP()
+#define MT_PROFILE_PUSH(NAME)
+#define MT_PROFILE_POP()
+#define MT_PROFILE_THREAD(THREAD_NAME)
+#define MT_PROFILE_UPDATE()
+#define MT_PROFILE_BEGIN_FRAME()
+#define MT_PROFILE_END_FRAME()
+#define MT_PROFILE_METADATA(NAME, DATA)
+
+#endif

include/momentum/common/progress_bar.h

@@ -0,0 +1,37 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <indicators/progress_bar.hpp>
+
+#include <string>
+
+namespace momentum {
+
+// A simple progress bar that prints hash marks (e.g., "Name [===>  ] 60%")
+class ProgressBar {
+ public:
+  /// @param prefix Displayed prefix
+  /// @param numOperations Total operations (determines progress ratio)
+  ProgressBar(const std::string& prefix, size_t numOperations);
+
+  /// Increments the progress by the given count (default 1)
+  void increment(size_t count = 1);
+
+  /// Sets the progress to the given count
+  void set(size_t count);
+
+  /// Returns the current progress in the range [0, 100]
+  [[nodiscard]] size_t getCurrentProgress();
+
+ private:
+  static constexpr size_t kMaxWidth = 80;
+  indicators::ProgressBar bar_;
+};
+
+} // namespace momentum

include/momentum/common/string.h

@@ -0,0 +1,52 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <string>
+#include <string_view>
+#include <vector>
+
+namespace momentum {
+
+/// Returns a copy of the string from which all the characters in whiteChars
+/// at the beginning or at the end of the string have been removed.
+/// @tparam StringType: The type of the string to trim (e.g., std::string, std::string_view)
+/// @param text: The string to trim
+/// @param whiteChars: A series of 1-byte characters to remove
+/// @return The trimmed string
+template <typename StringType>
+[[nodiscard]] StringType trim(const StringType& text, const char* whiteChars = " \t");
+
+/// Returns a copy of the string from which all the characters in whiteChars
+/// at the beginning or at the end of the string have been removed.
+/// @param text: The string to trim (null-terminated)
+/// @param whiteChars: A series of 1-byte characters to remove
+/// @return The trimmed string
+[[nodiscard]] std::string trim(const char* text, const char* whiteChars = " \t");
+
+/// Tokenize a string using the specified delimiters.
+///
+/// @param inputString The string to tokenize.
+/// @param delimiters The string containing delimiter characters.
+/// @param trim Whether to trim spaces around the tokens (default: true).
+/// @return A vector of tokenized strings.
+std::vector<std::string> tokenize(
+    const std::string& inputString,
+    const std::string& delimiters = " \t\r\n",
+    bool trim = true);
+
+/// Tokenize a string_view using the specified delimiters.
+///
+/// @param inputString The string_view to tokenize.
+/// @param delimiters The string_view containing delimiter characters.
+/// @param trim Whether to trim spaces around the tokens (default: true).
+/// @return A vector of tokenized string_views.
+std::vector<std::string_view>
+tokenize(std::string_view inputString, std::string_view delimiters = " \t\r\n", bool trim = true);
+
+} // namespace momentum

include/momentum/diff_ik/ceres_utility.h

@@ -0,0 +1,73 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/character/parameter_transform.h>
+#include <momentum/character/skeleton_state.h>
+
+#include <ceres/jet.h>
+#include <Eigen/Core>
+
+namespace momentum {
+
+template <typename T, typename T2>
+Eigen::Vector3<T>
+getRotationDerivative(const JointStateT<T2>& js, const size_t index, const Eigen::Vector3<T>& ref) {
+  return js.rotationAxis.col(index).cross(ref);
+}
+
+template <typename T, typename T2>
+Eigen::Vector3<T> getScaleDerivative(const JointStateT<T2>& js, const Eigen::Vector3<T>& ref) {
+  (void)js;
+  return ref * ln2<T2>();
+}
+
+template <typename T, int N>
+Eigen::Matrix<ceres::Jet<T, N>, N, 1> buildJetVec(const Eigen::Matrix<T, N, 1>& v) {
+  Eigen::Matrix<ceres::Jet<T, N>, N, 1> result;
+  for (int k = 0; k < N; ++k) {
+    result(k).a = v(k);
+    result(k).v.setZero();
+    result(k).v(k) = 1;
+  }
+
+  return result;
+}
+
+template <typename T, int Rows, int Cols>
+Eigen::Matrix<ceres::Jet<T, Cols * Rows>, Rows, Cols> buildJetMat(
+    const Eigen::Matrix<T, Rows, Cols>& m) {
+  Eigen::Matrix<ceres::Jet<T, Cols * Rows>, Rows, Cols> result;
+  for (int iRow = 0; iRow < Rows; ++iRow) {
+    for (int jCol = 0; jCol < Cols; ++jCol) {
+      result(iRow, jCol).a = m(iRow, jCol);
+      result(iRow, jCol).v.setZero();
+      result(iRow, jCol).v(iRow * Cols + jCol) = 1;
+    }
+  }
+  return result;
+}
+
+template <typename T, typename T2>
+T times_parameterTransform_times_v(
+    const T& value,
+    const size_t jointParamIdx,
+    const ParameterTransform& parameterTransform,
+    Eigen::Ref<const Eigen::VectorX<T2>> v) {
+  T result = T();
+  for (auto index = parameterTransform.transform.outerIndexPtr()[jointParamIdx];
+       index < parameterTransform.transform.outerIndexPtr()[jointParamIdx + 1];
+       ++index) {
+    result += value * static_cast<T2>(parameterTransform.transform.valuePtr()[index]) *
+        v[parameterTransform.transform.innerIndexPtr()[index]];
+  }
+
+  return result;
+}
+
+} // namespace momentum

include/momentum/diff_ik/fully_differentiable_body_ik.h

@@ -0,0 +1,58 @@
+/*
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ */
+
+#pragma once
+
+#include <momentum/character/character.h>
+#include <momentum/character_solver/skeleton_error_function.h>
+#include <momentum/character_solver/skeleton_solver_function.h>
+#include <momentum/diff_ik/fwd.h>
+
+#include <unordered_map>
+#include <vector>
+
+namespace momentum {
+
+// This is going to be used within Pytorch's automatic differentiation package,
+// so we will assume the existence of a scalar "loss" function that is the thing
+// we are minimizing in Pytorch.  To clarify:
+//   "Error"/Error function: the thing that momentum's IK solver is minimizing
+//      to compute the body pose.
+//   "Loss"/Loss function: the thing that Pytorch is minimizing.
+// Here, we will be computing the derivative of the loss function with respect
+// to all the various error function inputs, like "weight" or "target".
+
+template <typename T>
+struct ErrorFunctionDerivativesT {
+  std::shared_ptr<const SkeletonErrorFunctionT<T>> errorFunction = nullptr;
+
+  // Gradient of the energy wrt the global weight.
+  T gradWeight = 0;
+
+  // Derivative of the energy wrt the various inputs.
+  std::unordered_map<std::string, Eigen::VectorX<T>> gradInputs;
+};
+
+// Takes in the derivative of the loss wrt the model parameters and
+// computes the derivative of the loss wrt the error function inputs,
+// assuming the model parameters are always the ones that (locally)
+// minimize the momentum IK error.
+//
+// The gradient_norm here can be used to determine if the derivatives
+// are valid; the computation only really works when the gradient
+// (wrt the subset of parameters that are allowed to vary) is close to 0.
+template <typename T>
+std::vector<ErrorFunctionDerivativesT<T>> d_modelParams_d_inputs(
+    const Skeleton& skeleton,
+    const ParameterTransformT<T>& parameterTransform,
+    const ParameterSet& activeParams,
+    const ModelParametersT<T>& parameters,
+    SkeletonSolverFunctionT<T>& solverFunction,
+    Eigen::Ref<const Eigen::VectorX<T>> dLoss_dModelParams,
+    T* gradientRmse = nullptr);
+
+} // namespace momentum