Skip to content

Commit

Permalink
Merge 696a341 into 76e9a4e
Browse files Browse the repository at this point in the history
  • Loading branch information
FrancoisCarouge committed Feb 17, 2024
2 parents 76e9a4e + 696a341 commit e5ff1da
Show file tree
Hide file tree
Showing 4 changed files with 15 additions and 0 deletions.
6 changes: 6 additions & 0 deletions include/fcarouge/kalman.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -163,6 +163,7 @@ class kalman final : public internal::conditional_member_types<internal::kalman<
private:
//! @name Private Member Types
//! @{

//! @brief Implementation details of the filter.
//!
//! @details The internal implementation, filtering strategies, and presence
Expand All @@ -174,13 +175,15 @@ class kalman final : public internal::conditional_member_types<internal::kalman<

//! @name Private Member Variables
//! @{

//! @brief Encapsulates the implementation details of the filter.
implementation filter;
//! @}

public:
//! @name Public Member Types
//! @{

//! @brief Type of the state estimate column vector X.
using state = implementation::state;

Expand Down Expand Up @@ -217,6 +220,7 @@ class kalman final : public internal::conditional_member_types<internal::kalman<

//! @name Public Member Functions
//! @{

//! @brief Constructs a Kalman filter without configuration.
//!
//! @complexity Constant.
Expand Down Expand Up @@ -292,6 +296,7 @@ class kalman final : public internal::conditional_member_types<internal::kalman<

//! @name Public Characteristics Member Functions
//! @{

//! @brief Returns the state estimate column vector X.
//!
//! @return The state estimate column vector X.
Expand Down Expand Up @@ -552,6 +557,7 @@ class kalman final : public internal::conditional_member_types<internal::kalman<

//! @name Public Filtering Member Functions
//! @{

//! @brief Produces estimates of the state variables and uncertainties.
//!
//! @details Also known as the propagation step. Implements the total
Expand Down
4 changes: 4 additions & 0 deletions include/fcarouge/utility.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -49,6 +49,7 @@ For more information, please refer to <https://unlicense.org> */
namespace fcarouge {
//! @name Concepts
//! @{

//! @brief Arithmetic concept.
//!
//! @details Any integer or floating point type.
Expand Down Expand Up @@ -94,6 +95,7 @@ concept has_output_model = internal::has_output_model<Filter>;

//! @name Types
//! @{

//! @brief Tuple-like pack type.
//!
//! @details An alternative to tuple-like types.
Expand Down Expand Up @@ -122,6 +124,7 @@ using quotient = internal::quotient<Numerator, Denominator>;

//! @name Functions
//! @{

//! @brief A user-definable algebraic division solution.
//!
//! @details Implemented for known libraries. User-definable in other cases.
Expand All @@ -135,6 +138,7 @@ constexpr auto operator/(const Numerator &lhs, const Denominator &rhs)

//! @name Algebraic Named Values
//! @{

//! @brief The identity matrix.
//!
//! @details User-defined.
Expand Down
2 changes: 2 additions & 0 deletions linalg/eigen/fcarouge/linalg.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -53,6 +53,7 @@ For more information, please refer to <https://unlicense.org> */
namespace fcarouge {
//! @name Algebraic Types
//! @{

//! @brief Compile-time sized Eigen3 matrix.
//!
//! @details Facade for Eigen3 implementation compatibility.
Expand All @@ -74,6 +75,7 @@ using column_vector = Eigen::Vector<Type, Row>;

//! @name Algebraic Named Values
//! @{

//! @brief The identity matrix Eigen specialization.
template <eigen Matrix>
inline const auto identity_v<Matrix>{Matrix::Identity()};
Expand Down
3 changes: 3 additions & 0 deletions linalg/lazy/fcarouge/linalg.hpp
Original file line number Diff line number Diff line change
Expand Up @@ -83,6 +83,7 @@ inline constexpr auto make_generator(Type element) -> std::generator<Type> {

//! @name Algebraic Types
//! @{

//! @brief Coroutine lazy matrix.
//!
//! @details The matrix is a generator. A coroutine range. Lazily generated
Expand Down Expand Up @@ -287,6 +288,7 @@ using column_vector = matrix<Type, Row, decltype(Row){1}, Copyable>;

//! @name Deduction Guides
//! @{

template <typename Type> matrix(Type) -> matrix<Type, 1, 1>;

template <typename Type, auto Row, auto Column>
Expand Down Expand Up @@ -321,6 +323,7 @@ auto make_zero_generator{[]() -> std::generator<Type> {

//! @name Algebraic Named Values
//! @{

//! @brief The identity matrix lazy specialization.
template <typename Type, auto Row, auto Column>
auto identity_v<matrix<Type, Row, Column>>{[](auto... args) {
Expand Down

0 comments on commit e5ff1da

Please sign in to comment.