Logarithm Class Reference

Defines the function \( f: \lambda \mapsto \log(\lambda) \). More...

#include <logarithm.h>

Inheritance diagram for Logarithm:

Collaboration diagram for Logarithm:

Public Member Functions
virtual float	function (const float lambda_) const
virtual double	function (const double lambda_) const
virtual long double	function (const long double lambda_) const
Public Member Functions inherited from Function
virtual	~Function ()
	Default virtual destructor.

Detailed Description

Defines the function \( f: \lambda \mapsto \log(\lambda) \).

The matrix function \( f: \mathbb{R}^{n \times n} \to \mathbb{R}^{n \times n} \) is used in

\[ \mathrm{trace} \left( f(\mathbf{A}) \right). \]

However, instead of a matrix function, the equivalent scalar function \( f: \mathbb{R} \to \mathbb{R} \) is defiend which acts on the eigenvalues of the matrix.

Definition at line 40 of file logarithm.h.

Member Function Documentation

function() [1/3]

double Logarithm::function ( const double  lambda_ ) const

virtual

Parameters

[in]

lambda_

Eigenvalue (or singular value) of matrix.

Returns

The value of matrix function for the given eigenvalue.

Implements Function.

Definition at line 42 of file logarithm.cpp.

{
    return std::log(lambda_);
}

function() [2/3]

float Logarithm::function ( const float  lambda_ ) const

virtual

Parameters

[in]

lambda_

Eigenvalue (or singular value) of matrix.

Returns

The value of matrix function for the given eigenvalue.

Implements Function.

Definition at line 28 of file logarithm.cpp.

{
    return std::log(lambda_);
}

function() [3/3]

long double Logarithm::function ( const long double  lambda_ ) const

virtual

Parameters

[in]

lambda_

Eigenvalue (or singular value) of matrix.

Returns

The value of matrix function for the given eigenvalue.

Implements Function.

Definition at line 56 of file logarithm.cpp.

{
    return std::log(lambda_);
}

---

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

• /home/runner/work/imate/imate/imate/functions/logarithm.h
• /home/runner/work/imate/imate/imate/functions/logarithm.cpp