codac2_Matrix_addons_Base.h File Reference

This graph shows which files directly or indirectly include this file:

Go to the source code of this file.

Functions
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime>
Scalar &	operator() (Index i, Index j)
	Accesses a matrix element (modifiable) by its row and column indices.
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime>
const Scalar &	operator() (Index i, Index j) const
	Accesses a matrix element (non modifiable) by its row and column indices.
auto &	init (const Scalar &x)
	Initializes all elements of the matrix with the scalar value x.
template<typename U_, int R_, int C_>
bool	operator== (const Matrix< U_, R_, C_ > &x) const
	Compares this matrix with another matrix for equality.

Detailed Description

This file is included in the declaration of Eigen::MatrixBase, thanks to the preprocessor token EIGEN_MATRIX_PLUGIN. See: https://eigen.tuxfamily.org/dox/TopicCustomizing_Plugins.html and the file codac2_matrices.h

---

Date

2024

Author

Simon Rohou

Copyright

Copyright 2023 Codac Team

License: GNU Lesser General Public License (LGPL)

Function Documentation

operator()() [1/2]

template<int R = RowsAtCompileTime, int C = ColsAtCompileTime>

Scalar & operator() ( Index i, Index j )

inline

Accesses a matrix element (modifiable) by its row and column indices.

Provides mutable access to the element at the specified row i and column j. This operator allows both reading and writing of matrix elements.

Parameters

i	Row index of the element.
j	Column index of the element.

Returns

Reference to the element at position (i,j).

{
  return const_cast<Scalar&>(static_cast<const Matrix<Scalar,R,C>&>(*this).operator()(i,j));
}

operator()() [2/2]

template<int R = RowsAtCompileTime, int C = ColsAtCompileTime>

const Scalar & operator() ( Index i, Index j ) const

inline

Accesses a matrix element (non modifiable) by its row and column indices.

Provides reading access to the element at the specified row i and column j. This operator allows only reading of matrix elements.

Parameters

i	Row index of the element.
j	Column index of the element.

Returns

Const reference to the element at position (i,j).

{
  assert_release(i >= 0 && i < this->rows() && j >= 0 && j < this->cols());
 
  if constexpr(!IsVectorOrRow<R,C>)
    return this->PlainObjectBase<Matrix<Scalar,R,C>>::operator()(i,j);
 
  else
  {
    if constexpr(R == 1)
      return (*this)[j];
    return (*this)[i];
  }
}

init()

auto & init ( const Scalar & x )

inline

Initializes all elements of the matrix with the scalar value x.

Parameters

x	The scalar value to assign to each element.

Returns

Reference to the current matrix object (allows method chaining).

{
  for(Index i = 0 ; i < this->size() ; i++)
    *(this->data()+i) = x;
  return *this;
}

operator==()

template<typename U_, int R_, int C_>

bool operator== ( const Matrix< U_, R_, C_ > & x ) const

inline

Compares this matrix with another matrix for equality.

Parameters

x	The other matrix to compare against.

Returns

true if matrices have the same size, shape, and identical elements; false otherwise.

{
  // This operator should be related to Eigen::MatrixBase,
  // for allowing a comparison between two matrix expressions.
  // However, it is not possible to overwrite Eigen::MatrixBase::operator==.
  // Therefore, only comparisons between Eigen::Matrix types is possible.
  // This must be corrected...
 
  if(this->size() != x.size())
    return false;
 
  if constexpr(std::is_same_v<Scalar,codac2::Interval> && std::is_same_v<U_,codac2::Interval>)
  {
    if(this->is_empty() || x.is_empty())
      return this->is_empty() && x.is_empty();
  }
 
  if(this->rows() != x.rows() || this->cols() != x.cols())
    return false;
 
  for(Index i = 0 ; i < this->size() ; i++)
    if(*(this->data()+i) != *(x.data()+i))
      return false;
 
  return true;
}