num_prob_collect::roots::cubic_root_test_function Class Reference

Class of test function to calculate cubic root of a number. More...

#include <num_prob_collect/roots/cubic_root_test_function.h>

Collaboration diagram for num_prob_collect::roots::cubic_root_test_function:

Public Types
using	jacobian_type = double
	Type of Jacobian.
using	variable_type = double
	Type of variables.

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

Private Attributes
jacobian_type	jacobian_ {}
	Jacobian matrix.
variable_type	target_
	Value to calculate cubic root of.
variable_type	value_ {}
	Function value.

Detailed Description

Class of test function to calculate cubic root of a number.

Definition at line 27 of file cubic_root_test_function.h.

Member Typedef Documentation

jacobian_type

using num_prob_collect::roots::cubic_root_test_function::jacobian_type = double

Type of Jacobian.

Definition at line 33 of file cubic_root_test_function.h.

variable_type

using num_prob_collect::roots::cubic_root_test_function::variable_type = double

Type of variables.

Definition at line 30 of file cubic_root_test_function.h.

Constructor & Destructor Documentation

cubic_root_test_function()

num_prob_collect::roots::cubic_root_test_function::cubic_root_test_function ( variable_type target )

inlineexplicit

Constructor.

Parameters

[in]

target

Value to calculate cubic root of.

Definition at line 40 of file cubic_root_test_function.h.

Member Function Documentation

evaluate_on()

void num_prob_collect::roots::cubic_root_test_function::evaluate_on ( const variable_type & variable )

inline

Evaluate on a variable.

Parameters

[in]

variable

Variable.

Definition at line 47 of file cubic_root_test_function.h.

jacobian()

auto num_prob_collect::roots::cubic_root_test_function::jacobian ( ) const -> const jacobian_type&

inlinenodiscardnoexcept

Get Jacobian matrix.

Returns

Jacobian matrix.

Definition at line 66 of file cubic_root_test_function.h.

value()

auto num_prob_collect::roots::cubic_root_test_function::value ( ) const -> const variable_type&

inlinenodiscardnoexcept

Get function value.

Returns

Function value.

Definition at line 57 of file cubic_root_test_function.h.

Member Data Documentation

jacobian_

jacobian_type num_prob_collect::roots::cubic_root_test_function::jacobian_ {}

private

Jacobian matrix.

Definition at line 78 of file cubic_root_test_function.h.

target_

variable_type num_prob_collect::roots::cubic_root_test_function::target_

private

Value to calculate cubic root of.

Definition at line 72 of file cubic_root_test_function.h.

value_

variable_type num_prob_collect::roots::cubic_root_test_function::value_ {}

private

Function value.

Definition at line 75 of file cubic_root_test_function.h.

---

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

• problems/include/num_prob_collect/roots/cubic_root_test_function.h