codac2_MatrixBase_addons_Vector.h File Reference

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

Go to the source code of this file.

Functions
template<typename U = Scalar, int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires (!IsIntervalDomain<U>) && (IsVectorOrRow<R,C>)
Index	min_coeff_index () const
	Returns the index of the minimum coefficient in the vector.
template<typename U = Scalar, int R = RowsAtCompileTime, int C = ColsAtCompileTime> requires (!IsIntervalDomain<U>) && (IsVectorOrRow<R,C>)
Index	max_coeff_index () const
	Returns the index of the maximum coefficient in the vector.

Detailed Description

This file is included in the declaration of Eigen::MatrixBase, thanks to the preprocessor token EIGEN_MATRIXBASE_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

min_coeff_index()

template<typename U = Scalar, int R = RowsAtCompileTime, int C = ColsAtCompileTime>
requires (!IsIntervalDomain<U>) && (IsVectorOrRow<R,C>)

Index min_coeff_index ( ) const

inline

Returns the index of the minimum coefficient in the vector.

Returns

The index (0-based) of the minimum coefficient.

Note

For a column vector, the returned index is the row index. For a row vector, it is the column index.

{
  Index r,c;
  this->minCoeff(&r,&c);
  assert((C == 1 && c == 0) || (R == 1 && r == 0));
  return r;
}

max_coeff_index()

template<typename U = Scalar, int R = RowsAtCompileTime, int C = ColsAtCompileTime>
requires (!IsIntervalDomain<U>) && (IsVectorOrRow<R,C>)

Index max_coeff_index ( ) const

inline

Returns the index of the maximum coefficient in the vector.

Returns

The index (0-based) of the maximum coefficient.

Note

For a column vector, the returned index is the row index. For a row vector, it is the column index.

{
  Index r,c;
  this->maxCoeff(&r,&c);
  assert((C == 1 && c == 0) || (R == 1 && r == 0));
  return r;
}