codac2_MatrixBase_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
bool	is_squared () const
	Checks if the matrix is square.
auto	squared_norm () const
	Returns the squared norm of the matrix.
Scalar	min_coeff () const
	Returns the minimum coefficient in the matrix.
Scalar	max_coeff () const
	Returns the maximum coefficient in the matrix.
bool	is_nan () const
	Checks if any coefficient in the matrix is NaN.

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

is_squared()

bool is_squared ( ) const

inline

Checks if the matrix is square.

Returns

True if the number of rows equals the number of columns.

{
  return this->rows() == this->cols();
}

squared_norm()

auto squared_norm ( ) const

inline

Returns the squared norm of the matrix.

Returns

The squared norm value.

{
  return this->squaredNorm();
}

min_coeff()

Scalar min_coeff ( ) const

inline

Returns the minimum coefficient in the matrix.

Returns

The minimum coefficient value.

{
  minmax_item(min);
}

max_coeff()

Scalar max_coeff ( ) const

inline

Returns the maximum coefficient in the matrix.

Returns

The maximum coefficient value.

{
  minmax_item(max);
}

is_nan()

bool is_nan ( ) const

inline

Checks if any coefficient in the matrix is NaN.

Returns

True if any element is NaN, false otherwise.

{
  return this->array().isNaN().any();
}