num_collect::functions::impl::legendre_for_newton< T > Class Template Reference

Class of Legendre function to use with num_collect::roots::newton_raphson class. More...

#include <num_collect/functions/legendre_roots.h>

Collaboration diagram for num_collect::functions::impl::legendre_for_newton< T >:

Public Types
using	jacobian_type = T
	Type of Jacobians.
using	variable_type = T
	Type of variables.

Public Member Functions
	legendre_for_newton (index_type degree)
	Constructor.
void	evaluate_on (const variable_type &variable)
	Evaluate on a variable.
auto	jacobian () const noexcept -> const jacobian_type &
	Get Jacobian.
auto	value () const noexcept -> const variable_type &
	Get function value.

Private Attributes
index_type	degree_
	Degree of Legendre function.
jacobian_type	jacobian_ {}
	Jacobian matrix.
variable_type	value_ {}
	Function value.

Detailed Description

template<base::concepts::real_scalar T>
class num_collect::functions::impl::legendre_for_newton< T >

Class of Legendre function to use with num_collect::roots::newton_raphson class.

Template Parameters

T	Type of variable.

Definition at line 50 of file legendre_roots.h.

Member Typedef Documentation

jacobian_type

template<base::concepts::real_scalar T>

using num_collect::functions::impl::legendre_for_newton< T >::jacobian_type = T

Type of Jacobians.

Definition at line 56 of file legendre_roots.h.

variable_type

template<base::concepts::real_scalar T>

using num_collect::functions::impl::legendre_for_newton< T >::variable_type = T

Type of variables.

Definition at line 53 of file legendre_roots.h.

Constructor & Destructor Documentation

legendre_for_newton()

template<base::concepts::real_scalar T>

num_collect::functions::impl::legendre_for_newton< T >::legendre_for_newton ( index_type degree )

inlineexplicit

Constructor.

Parameters

[in]

degree

Degree of Legendre function.

Definition at line 63 of file legendre_roots.h.

Member Function Documentation

evaluate_on()

template<base::concepts::real_scalar T>

void num_collect::functions::impl::legendre_for_newton< T >::evaluate_on ( const variable_type & variable )

inline

Evaluate on a variable.

Parameters

[in]

variable

Variable.

Definition at line 73 of file legendre_roots.h.

jacobian()

template<base::concepts::real_scalar T>

auto num_collect::functions::impl::legendre_for_newton< T >::jacobian ( ) const -> const jacobian_type&

inlinenodiscardnoexcept

Get Jacobian.

Returns

Jacobian.

Definition at line 91 of file legendre_roots.h.

value()

template<base::concepts::real_scalar T>

auto num_collect::functions::impl::legendre_for_newton< T >::value ( ) const -> const variable_type&

inlinenodiscardnoexcept

Get function value.

Returns

Function value.

Definition at line 82 of file legendre_roots.h.

Member Data Documentation

degree_

template<base::concepts::real_scalar T>

index_type num_collect::functions::impl::legendre_for_newton< T >::degree_

private

Degree of Legendre function.

Definition at line 97 of file legendre_roots.h.

jacobian_

template<base::concepts::real_scalar T>

jacobian_type num_collect::functions::impl::legendre_for_newton< T >::jacobian_ {}

private

Jacobian matrix.

Definition at line 103 of file legendre_roots.h.

value_

template<base::concepts::real_scalar T>

variable_type num_collect::functions::impl::legendre_for_newton< T >::value_ {}

private

Function value.

Definition at line 100 of file legendre_roots.h.

---

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

• include/num_collect/functions/legendre_roots.h