OpenKalman
Public Member Functions | List of all members
OpenKalman::IdentityTransform Struct Reference

An identity transform from one statistical distribution to another. More...

#include <IdentityTransform.hpp>

Inheritance diagram for OpenKalman::IdentityTransform:
Inheritance graph
[legend]
Collaboration diagram for OpenKalman::IdentityTransform:
Collaboration graph
[legend]

Public Member Functions

template<typename InputDist , typename ... NoiseDists, std::enable_if_t<(distribution< InputDist > and ... and distribution< NoiseDists >) and(coordinates::compares_with< typename DistributionTraits< InputDist >::StaticDescriptor, typename DistributionTraits< NoiseDists >::StaticDescriptor > and ...), int > = 0>
auto operator() (const InputDist &x, const NoiseDists &... ns) const
 Apply the identity transform on an input distribution. More...
 
template<typename InputDist , typename ... NoiseDists, std::enable_if_t<(distribution< InputDist > and ... and distribution< NoiseDists >) and(coordinates::compares_with< typename DistributionTraits< InputDist >::StaticDescriptor, typename DistributionTraits< NoiseDists >::StaticDescriptor > and ...), int > = 0>
auto transform_with_cross_covariance (const InputDist &x, const NoiseDists &... ns) const
 Perform identity transform, also returning the cross-covariance. More...
 
- Public Member Functions inherited from OpenKalman::internal::TransformBase< IdentityTransform >
auto operator() (const InputDist &x, const T &t, const Ts &...ts) const
 Perform one or more consecutive transforms. More...
 
auto transform_with_cross_covariance (const InputDist &x, const T &t, const Ts &...ts) const
 Perform one or more consecutive transforms, also returning the cross-covariance. More...
 

Detailed Description

An identity transform from one statistical distribution to another.

Member Function Documentation

◆ operator()()

template<typename InputDist , typename ... NoiseDists, std::enable_if_t<(distribution< InputDist > and ... and distribution< NoiseDists >) and(coordinates::compares_with< typename DistributionTraits< InputDist >::StaticDescriptor, typename DistributionTraits< NoiseDists >::StaticDescriptor > and ...), int > = 0>
auto OpenKalman::IdentityTransform::operator() ( const InputDist &  x,
const NoiseDists &...  ns 
) const
inline

Apply the identity transform on an input distribution.

Any noise distributions are treated as additive.

Template Parameters
InputDistThe prior distribution.
NoiseDistsNoise distribution.
Returns
The posterior distribution.

◆ transform_with_cross_covariance()

template<typename InputDist , typename ... NoiseDists, std::enable_if_t<(distribution< InputDist > and ... and distribution< NoiseDists >) and(coordinates::compares_with< typename DistributionTraits< InputDist >::StaticDescriptor, typename DistributionTraits< NoiseDists >::StaticDescriptor > and ...), int > = 0>
auto OpenKalman::IdentityTransform::transform_with_cross_covariance ( const InputDist &  x,
const NoiseDists &...  ns 
) const
inline

Perform identity transform, also returning the cross-covariance.

Template Parameters
InputDistThe prior distribution.
NoiseDistsNoise distributions.
Returns
A tuple comprising the posterior distribution and the cross-covariance.

The documentation for this struct was generated from the following file: