codac2::OctaSym Class Reference

Represents an hyperoctahedral symmetry. More...

#include <codac2_OctaSym.h>

Public Member Functions
	OctaSym (std::initializer_list< int > s)
	Constructs an hyperoctahedral symmetry from a list of integers. The list represents the second line in the Cauchy' representation. It is supposed that the first line of the representation is (1 2 3 ... n).
	OctaSym (const std::vector< int > &s)
	Constructs an hyperoctahedral symmetry from a vector of integers. The vector represents the second line in the Cauchy' representation. It is supposed that the first line of the representation is (1 2 3 ... n).
OctaSym	invert () const
	Inverts of the hyperoctahedral symmetry.
OctaSym	operator* (const OctaSym &s) const
	Composes the hyperoctahedral symmetry with another one.
Matrix	permutation_matrix () const
	Computes the permutation matrix associated to the hyperoctahedral symmetry.
template<typename Derived>
Mat< typename Derived::Scalar,-1, 1 >	operator() (const Eigen::MatrixBase< Derived > &x) const
	Applies the hyperoctahedral symmetry to a vector.
template<typename C>
CtcAction	operator() (const C &c) const
	Applies the hyperoctahedral symmetry to a Contractor.
template<typename S>
SepAction	operator() (const S &s) const
	Applies the hyperoctahedral symmetry to a Separator.
std::shared_ptr< SetExpr >	operator() (const std::shared_ptr< SetExpr > &x1) const
	Applies the hyperoctahedral symmetry to a SetExpr.
template<typename V>
VectorExpr	operator() (const V &x1) const
	Applies the hyperoctahedral symmetry to a VectorExpr or a VectorVar.

Detailed Description

Represents an hyperoctahedral symmetry.

Constructor & Destructor Documentation

OctaSym() [1/2]

codac2::OctaSym::OctaSym

(

std::initializer_list< int >

s

)

Constructs an hyperoctahedral symmetry from a list of integers. The list represents the second line in the Cauchy' representation. It is supposed that the first line of the representation is (1 2 3 ... n).

Parameters

s	The list of integers representing the hyperoctahedral symmetry.

OctaSym() [2/2]

codac2::OctaSym::OctaSym

(

const std::vector< int > &

s

)

Constructs an hyperoctahedral symmetry from a vector of integers. The vector represents the second line in the Cauchy' representation. It is supposed that the first line of the representation is (1 2 3 ... n).

Parameters

s	The vector of integers representing the hyperoctahedral symmetry.

Member Function Documentation

invert()

OctaSym codac2::OctaSym::invert

(

)

const

Inverts of the hyperoctahedral symmetry.

Returns

The inverse of the hyperoctahedral symmetry.

operator*()

OctaSym codac2::OctaSym::operator*

(

const OctaSym &

s

)

const

Composes the hyperoctahedral symmetry with another one.

Parameters

s	The hyperoctahedral symmetry to compose with.

Returns

The composition of the two hyperoctahedral symmetries.

permutation_matrix()

Matrix codac2::OctaSym::permutation_matrix

(

)

const

Computes the permutation matrix associated to the hyperoctahedral symmetry.

Returns

The permutation matrix associated to the hyperoctahedral symmetry.

operator()() [1/5]

template<typename Derived>

Mat< typename Derived::Scalar,-1, 1 > codac2::OctaSym::operator() ( const Eigen::MatrixBase< Derived > & x ) const

inline

Applies the hyperoctahedral symmetry to a vector.

Parameters

x	The Vector or IntervalVector to which the hyperoctahedral symmetry is applied.

Returns

The result of the application of the hyperoctahedral symmetry to the vector.

      {
        assert_release(x.size() == (Index)size());
        Mat<typename Derived::Scalar,-1,1> x_(x);
        for(size_t i = 0 ; i < size() ; i++)
          x_[i] = sign((*this)[i])*x[std::abs((*this)[i])-1];
        return x_;
      }

operator()() [2/5]

template<typename C>

CtcAction codac2::OctaSym::operator() ( const C & c ) const

inline

Applies the hyperoctahedral symmetry to a Contractor.

Parameters

c	The Contractor to which the hyperoctahedral symmetry is applied.

Returns

The result of the application of the hyperoctahedral symmetry to the Contractor.

  {
    return CtcAction(c, *this);
  }

operator()() [3/5]

template<typename S>

SepAction codac2::OctaSym::operator() ( const S & s ) const

inline

Applies the hyperoctahedral symmetry to a Separator.

Parameters

s	The Separator to which the hyperoctahedral symmetry is applied.

Returns

The result of the application of the hyperoctahedral symmetry to the Separator.

  {
    return SepAction(s, *this);
  }

operator()() [4/5]

std::shared_ptr< SetExpr > codac2::OctaSym::operator() ( const std::shared_ptr< SetExpr > & x1 ) const

inline

Applies the hyperoctahedral symmetry to a SetExpr.

Parameters

x1	The SetExpr to which the hyperoctahedral symmetry is applied.

Returns

The result of the application of the hyperoctahedral symmetry to the SetExpr.

  {
    return std::make_shared<SetOperationExpr<ActionSetOp,SetExpr>>(*this,x1);
  }

operator()() [5/5]

template<typename V>

VectorExpr codac2::OctaSym::operator() ( const V & x1 ) const

inline

Applies the hyperoctahedral symmetry to a VectorExpr or a VectorVar.

Parameters

x1	The VectorExpr or VectorVar to which the hyperoctahedral symmetry is applied.

Returns

The result of the application of the hyperoctahedral symmetry to the VectorExpr or VectorVar.

      {
        if constexpr(std::is_same_v<V,VectorExpr>)
          assert_release((Index)this->size() == x1->output_shape().first);
        else
          assert_release((Index)this->size() == x1.output_shape().first);
        return { std::make_shared<AnalyticOperationExpr<OctaSymOp,VectorType,VectorType>>(*this, x1) };
      }

---

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

• /home/simon/codac-simon/src/core/actions/codac2_OctaSym.h
• /home/simon/codac-simon/src/core/contractors/codac2_CtcAction.h
• /home/simon/codac-simon/src/core/functions/set/codac2_set_operations.h
• /home/simon/codac-simon/src/core/separators/codac2_SepAction.h