WPILibC++ 2023.4.3-108-ge5452e3
Eigen::symbolic::BaseExpr< Derived > Class Template Reference

Common base class of any symbolic expressions. More...

#include </home/runner/work/allwpilib/allwpilib/wpimath/src/main/native/thirdparty/eigen/include/Eigen/src/Core/util/SymbolicIndex.h>

Public Member Functions

const Derived & derived () const
 
template<typename T >
Index eval (const T &values) const
 Evaluate the expression given the values of the symbols. More...
 
NegateExpr< Derived > operator- () const
 
AddExpr< Derived, ValueExpr<> > operator+ (Index b) const
 
AddExpr< Derived, ValueExpr<> > operator- (Index a) const
 
ProductExpr< Derived, ValueExpr<> > operator* (Index a) const
 
QuotientExpr< Derived, ValueExpr<> > operator/ (Index a) const
 
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator+ (internal::FixedInt< N >) const
 
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt<-N > > > operator- (internal::FixedInt< N >) const
 
template<int N>
ProductExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator* (internal::FixedInt< N >) const
 
template<int N>
QuotientExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator/ (internal::FixedInt< N >) const
 
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator+ (internal::FixedInt< N >(*)()) const
 
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt<-N > > > operator- (internal::FixedInt< N >(*)()) const
 
template<int N>
ProductExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator* (internal::FixedInt< N >(*)()) const
 
template<int N>
QuotientExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator/ (internal::FixedInt< N >(*)()) const
 
template<typename OtherDerived >
AddExpr< Derived, OtherDerived > operator+ (const BaseExpr< OtherDerived > &b) const
 
template<typename OtherDerived >
AddExpr< Derived, NegateExpr< OtherDerived > > operator- (const BaseExpr< OtherDerived > &b) const
 
template<typename OtherDerived >
ProductExpr< Derived, OtherDerived > operator* (const BaseExpr< OtherDerived > &b) const
 
template<typename OtherDerived >
QuotientExpr< Derived, OtherDerived > operator/ (const BaseExpr< OtherDerived > &b) const
 

Friends

AddExpr< Derived, ValueExpr<> > operator+ (Index a, const BaseExpr &b)
 
AddExpr< NegateExpr< Derived >, ValueExpr<> > operator- (Index a, const BaseExpr &b)
 
ProductExpr< ValueExpr<>, Derived > operator* (Index a, const BaseExpr &b)
 
QuotientExpr< ValueExpr<>, Derived > operator/ (Index a, const BaseExpr &b)
 
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator+ (internal::FixedInt< N >, const BaseExpr &b)
 
template<int N>
AddExpr< NegateExpr< Derived >, ValueExpr< internal::FixedInt< N > > > operator- (internal::FixedInt< N >, const BaseExpr &b)
 
template<int N>
ProductExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator* (internal::FixedInt< N >, const BaseExpr &b)
 
template<int N>
QuotientExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator/ (internal::FixedInt< N >, const BaseExpr &b)
 
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator+ (internal::FixedInt< N >(*)(), const BaseExpr &b)
 
template<int N>
AddExpr< NegateExpr< Derived >, ValueExpr< internal::FixedInt< N > > > operator- (internal::FixedInt< N >(*)(), const BaseExpr &b)
 
template<int N>
ProductExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator* (internal::FixedInt< N >(*)(), const BaseExpr &b)
 
template<int N>
QuotientExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator/ (internal::FixedInt< N >(*)(), const BaseExpr &b)
 

Detailed Description

template<typename Derived>
class Eigen::symbolic::BaseExpr< Derived >

Common base class of any symbolic expressions.

Member Function Documentation

◆ derived()

template<typename Derived >
const Derived & Eigen::symbolic::BaseExpr< Derived >::derived ( ) const
inline

◆ eval()

template<typename Derived >
template<typename T >
Index Eigen::symbolic::BaseExpr< Derived >::eval ( const T &  values) const
inline

Evaluate the expression given the values of the symbols.

Parameters
valuesdefines the values of the symbols, it can either be a SymbolValue or a std::tuple of SymbolValue as constructed by SymbolExpr::operator= operator.

◆ operator*() [1/4]

template<typename Derived >
template<typename OtherDerived >
ProductExpr< Derived, OtherDerived > Eigen::symbolic::BaseExpr< Derived >::operator* ( const BaseExpr< OtherDerived > &  b) const
inline

◆ operator*() [2/4]

template<typename Derived >
ProductExpr< Derived, ValueExpr<> > Eigen::symbolic::BaseExpr< Derived >::operator* ( Index  a) const
inline

◆ operator*() [3/4]

template<typename Derived >
template<int N>
ProductExpr< Derived, ValueExpr< internal::FixedInt< N > > > Eigen::symbolic::BaseExpr< Derived >::operator* ( internal::FixedInt< N >  *)() const
inline

◆ operator*() [4/4]

template<typename Derived >
template<int N>
ProductExpr< Derived, ValueExpr< internal::FixedInt< N > > > Eigen::symbolic::BaseExpr< Derived >::operator* ( internal::FixedInt< N >  ) const
inline

◆ operator+() [1/4]

template<typename Derived >
template<typename OtherDerived >
AddExpr< Derived, OtherDerived > Eigen::symbolic::BaseExpr< Derived >::operator+ ( const BaseExpr< OtherDerived > &  b) const
inline

◆ operator+() [2/4]

template<typename Derived >
AddExpr< Derived, ValueExpr<> > Eigen::symbolic::BaseExpr< Derived >::operator+ ( Index  b) const
inline

◆ operator+() [3/4]

template<typename Derived >
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > Eigen::symbolic::BaseExpr< Derived >::operator+ ( internal::FixedInt< N >  *)() const
inline

◆ operator+() [4/4]

template<typename Derived >
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > Eigen::symbolic::BaseExpr< Derived >::operator+ ( internal::FixedInt< N >  ) const
inline

◆ operator-() [1/5]

template<typename Derived >
NegateExpr< Derived > Eigen::symbolic::BaseExpr< Derived >::operator- ( ) const
inline

◆ operator-() [2/5]

template<typename Derived >
template<typename OtherDerived >
AddExpr< Derived, NegateExpr< OtherDerived > > Eigen::symbolic::BaseExpr< Derived >::operator- ( const BaseExpr< OtherDerived > &  b) const
inline

◆ operator-() [3/5]

template<typename Derived >
AddExpr< Derived, ValueExpr<> > Eigen::symbolic::BaseExpr< Derived >::operator- ( Index  a) const
inline

◆ operator-() [4/5]

template<typename Derived >
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt<-N > > > Eigen::symbolic::BaseExpr< Derived >::operator- ( internal::FixedInt< N >  *)() const
inline

◆ operator-() [5/5]

template<typename Derived >
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt<-N > > > Eigen::symbolic::BaseExpr< Derived >::operator- ( internal::FixedInt< N >  ) const
inline

◆ operator/() [1/4]

template<typename Derived >
template<typename OtherDerived >
QuotientExpr< Derived, OtherDerived > Eigen::symbolic::BaseExpr< Derived >::operator/ ( const BaseExpr< OtherDerived > &  b) const
inline

◆ operator/() [2/4]

template<typename Derived >
QuotientExpr< Derived, ValueExpr<> > Eigen::symbolic::BaseExpr< Derived >::operator/ ( Index  a) const
inline

◆ operator/() [3/4]

template<typename Derived >
template<int N>
QuotientExpr< Derived, ValueExpr< internal::FixedInt< N > > > Eigen::symbolic::BaseExpr< Derived >::operator/ ( internal::FixedInt< N >  *)() const
inline

◆ operator/() [4/4]

template<typename Derived >
template<int N>
QuotientExpr< Derived, ValueExpr< internal::FixedInt< N > > > Eigen::symbolic::BaseExpr< Derived >::operator/ ( internal::FixedInt< N >  ) const
inline

Friends And Related Function Documentation

◆ operator* [1/3]

template<typename Derived >
ProductExpr< ValueExpr<>, Derived > operator* ( Index  a,
const BaseExpr< Derived > &  b 
)
friend

◆ operator* [2/3]

template<typename Derived >
template<int N>
ProductExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator* ( internal::FixedInt< N >  *)(,
const BaseExpr< Derived > &  b 
)
friend

◆ operator* [3/3]

template<typename Derived >
template<int N>
ProductExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator* ( internal::FixedInt< N >  ,
const BaseExpr< Derived > &  b 
)
friend

◆ operator+ [1/3]

template<typename Derived >
AddExpr< Derived, ValueExpr<> > operator+ ( Index  a,
const BaseExpr< Derived > &  b 
)
friend

◆ operator+ [2/3]

template<typename Derived >
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator+ ( internal::FixedInt< N >  *)(,
const BaseExpr< Derived > &  b 
)
friend

◆ operator+ [3/3]

template<typename Derived >
template<int N>
AddExpr< Derived, ValueExpr< internal::FixedInt< N > > > operator+ ( internal::FixedInt< N >  ,
const BaseExpr< Derived > &  b 
)
friend

◆ operator- [1/3]

template<typename Derived >
AddExpr< NegateExpr< Derived >, ValueExpr<> > operator- ( Index  a,
const BaseExpr< Derived > &  b 
)
friend

◆ operator- [2/3]

template<typename Derived >
template<int N>
AddExpr< NegateExpr< Derived >, ValueExpr< internal::FixedInt< N > > > operator- ( internal::FixedInt< N >  *)(,
const BaseExpr< Derived > &  b 
)
friend

◆ operator- [3/3]

template<typename Derived >
template<int N>
AddExpr< NegateExpr< Derived >, ValueExpr< internal::FixedInt< N > > > operator- ( internal::FixedInt< N >  ,
const BaseExpr< Derived > &  b 
)
friend

◆ operator/ [1/3]

template<typename Derived >
QuotientExpr< ValueExpr<>, Derived > operator/ ( Index  a,
const BaseExpr< Derived > &  b 
)
friend

◆ operator/ [2/3]

template<typename Derived >
template<int N>
QuotientExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator/ ( internal::FixedInt< N >  *)(,
const BaseExpr< Derived > &  b 
)
friend

◆ operator/ [3/3]

template<typename Derived >
template<int N>
QuotientExpr< ValueExpr< internal::FixedInt< N > >, Derived > operator/ ( internal::FixedInt< N >  ,
const BaseExpr< Derived > &  b 
)
friend

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