codac2_Matrix_addons_VectorBase.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> requires IsVectorOrRow<R,C>
	Matrix (int n)
	Constructs a vector or row matrix with size n.
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires IsVectorOrRow<R,C>
	Matrix (const std::vector< double > &v)
	Constructs a vector or row matrix from a vector of doubles.
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires IsVectorOrRow<R,C>
Scalar &	operator() (Index i)
	Access element at index i (mutable).
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires IsVectorOrRow<R,C>
const Scalar &	operator() (Index i) const
	Access element at index i (const).
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires IsVectorOrRow<R,C>
Scalar &	operator[] (Index i)
	Access element at index i (mutable) via operator[].
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires IsVectorOrRow<R,C>
const Scalar &	operator[] (Index i) const
	Access element at index i (const) via operator[].
template<typename OtherDerived, int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires IsVectorOrRow<R,C> && IsVectorOrRow<MatrixBase<OtherDerived>::RowsAtCompileTime,MatrixBase<OtherDerived>::ColsAtCompileTime>
void	put (Index start_id, const MatrixBase< OtherDerived > &x)
	Inserts values from matrix x starting at index start_id.
template<int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires IsVectorOrRow<R,C>
void	resize_save_values (Index n)
	Resizes the vector or row matrix to size n, preserving existing values.

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 2024 Codac Team

License: GNU Lesser General Public License (LGPL)

Function Documentation

Matrix() [1/2]

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

Matrix ( int n )

explicit

Constructs a vector or row matrix with size n.

Precondition

The matrix is a vector or row vector (IsVectorOrRow<R,C>).

Parameters

n	Number of elements.

Initializes the matrix to zero if Scalar is not an interval domain.

{
  Base::template _init2<int,int>(R == 1 ? 1 : n, C == 1 ? 1 : n);
  if constexpr(!IsIntervalDomain<Scalar>)
    init(0.);
}

Matrix() [2/2]

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

Matrix ( const std::vector< double > & v )

explicit

Constructs a vector or row matrix from a vector of doubles.

Precondition

The matrix is a vector or row vector (IsVectorOrRow<R,C>).

Parameters

v	Vector of doubles to initialize the matrix.

  : Matrix<Scalar,R,C>(R == 1 ? 1 : v.size(), C == 1 ? 1 : v.size())
{
  for(size_t i = 0 ; i < v.size() ; i++)
    (*this)[i] = v[i];
}

operator()() [1/2]

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

Scalar & operator() ( Index i )

inline

Access element at index i (mutable).

Precondition

The matrix is a vector or row vector (IsVectorOrRow<R,C>).

Parameters

i	Index of the element.

Returns

Reference to the element at index i.

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

operator()() [2/2]

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

const Scalar & operator() ( Index i ) const

inline

Access element at index i (const).

Precondition

The matrix is a vector or row vector (IsVectorOrRow<R,C>).

Parameters

i	Index of the element.

Returns

Const reference to the element at index i.

{
  assert_release(i >= 0 && i < this->size());
  return this->PlainObjectBase<Matrix<Scalar,R,C>>::operator()(i);
}

operator[]() [1/2]

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

Scalar & operator[] ( Index i )

inline

Access element at index i (mutable) via operator[].

Precondition

The matrix is a vector or row vector (IsVectorOrRow<R,C>).

Parameters

i	Index of the element.

Returns

Reference to the element at index i.

{
  return const_cast<Scalar&>(const_cast<const Matrix<Scalar,R,C>*>(this)->operator[](i));
}

operator[]() [2/2]

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

const Scalar & operator[] ( Index i ) const

inline

Access element at index i (const) via operator[].

Precondition

The matrix is a vector or row vector (IsVectorOrRow<R,C>).

Parameters

i	Index of the element.

Returns

Const reference to the element at index i.

{
  assert_release(i >= 0 && i < this->size());
  return this->PlainObjectBase<Matrix<Scalar,R,C>>::operator[](i);
}

put()

template<typename OtherDerived, int R = RowsAtCompileTime, int C = ColsAtCompileTime>
requires IsVectorOrRow<R,C> && IsVectorOrRow<MatrixBase<OtherDerived>::RowsAtCompileTime,MatrixBase<OtherDerived>::ColsAtCompileTime>

void put ( Index start_id, const MatrixBase< OtherDerived > & x )

inline

Inserts values from matrix x starting at index start_id.

Precondition

The matrix and x are both vectors or row vectors.

Parameters

start_id	Start index for insertion.
x	The matrix whose values will be inserted.

{
  assert_release(start_id >= 0 && start_id < this->size());
  assert_release(start_id+x.size() <= this->size());
 
  this->segment(start_id,x.size()) << x;
}

resize_save_values()

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

void resize_save_values ( Index n )

inline

Resizes the vector or row matrix to size n, preserving existing values.

Precondition

The matrix is a vector or row vector.

Parameters

n	The new size.

Eigen's resize() discards existing data, so this function copies existing values before resizing and restores them afterward.

{
  // With resize() of Eigen, the data is reallocated and all previous values are lost.
  auto copy = *this;
  this->resize(n);
  for(Index i = 0 ; i < std::min((Index)copy.size(),n) ; i++)
    (*this)[i] = copy[i];
}