minitensor::Identity< S, NC, NV > Class Template Reference

#include <MiniTensor_TestFunctions.h>

Inheritance diagram for minitensor::Identity< S, NC, NV >:

Public Types
using	Base = Equality_Constraint< Identity< S, NC, NV >, S, NC, NV >

Public Member Functions
	Identity ()
template<typename T , Index N>
Vector< T, NC >	value (Vector< T, N > const &x)
template<typename T , Index N>
Matrix< T, NC, NV >	gradient (Vector< T, N > const &x)
Public Member Functions inherited from minitensor::Equality_Constraint< Identity< S, NC, NV >, S, NC, NV >
	Equality_Constraint ()
Vector< T, NC >	value (Identity< S, NC, NV > &c, Vector< T, N > const &x)
Matrix< T, NC, NV >	gradient (Identity< S, NC, NV > &c, Vector< T, N > const &x)

Static Public Attributes
static constexpr char const *const	NAME {"Identity Map"}
Static Public Attributes inherited from minitensor::Equality_Constraint< Identity< S, NC, NV >, S, NC, NV >
static constexpr bool	IS_EQUALITY
static constexpr Index	NUM_CONSTR
static constexpr Index	NUM_VAR

Additional Inherited Members
Public Attributes inherited from minitensor::Equality_Constraint< Identity< S, NC, NV >, S, NC, NV >
bool	failed

Detailed Description

template<typename S, Index NC, Index NV>
class minitensor::Identity< S, NC, NV >

Identity map equality constraint \( c(x) = x \) with NC constraints in NV variables.

Definition at line 1321 of file MiniTensor_TestFunctions.h.

Member Typedef Documentation

Base

template<typename S , Index NC, Index NV>

using minitensor::Identity< S, NC, NV >::Base = Equality_Constraint<Identity<S, NC, NV>, S, NC, NV>

Base class type.

Definition at line 1340 of file MiniTensor_TestFunctions.h.

Constructor & Destructor Documentation

Identity()

template<typename S , Index NC, Index NV>

minitensor::Identity< S, NC, NV >::Identity ( )

inline

Constructor.

Definition at line 1328 of file MiniTensor_TestFunctions.h.

Member Function Documentation

value()

template<typename S , Index NC, Index NV>

template<typename T , Index N>

Vector< T, NC > minitensor::Identity< S, NC, NV >::value ( Vector< T, N > const &  x )

inline

Constraint value.

Definition at line 1348 of file MiniTensor_TestFunctions.h.

gradient()

template<typename S , Index NC, Index NV>

template<typename T , Index N>

Matrix< T, NC, NV > minitensor::Identity< S, NC, NV >::gradient ( Vector< T, N > const &  x )

inline

Gradient (Jacobian) of the constraint.

Definition at line 1360 of file MiniTensor_TestFunctions.h.

Member Data Documentation

NAME

template<typename S , Index NC, Index NV>

constexpr char const* const minitensor::Identity< S, NC, NV >::NAME {"Identity Map"}

staticconstexpr

Function name.

Definition at line 1335 of file MiniTensor_TestFunctions.h.

---

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

• MiniTensor_TestFunctions.h