Class of test function with two cubic functions. More...

#include <num_prob_collect/roots/double_cubic_test_function.h>

Collaboration diagram for num_prob_collect::roots::double_cubic_test_function:

Public Types
using	jacobian_type = Eigen::Matrix2d
	Type of Jacobian matrices.

using	variable_type = Eigen::Vector2d
	Type of variables.

Public Member Functions
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	value_ {}
	Function value.

Detailed Description

Class of test function with two cubic functions.

Solution is [3, 2].

Definition at line 31 of file double_cubic_test_function.h.

Member Typedef Documentation

◆ jacobian_type

using num_prob_collect::roots::double_cubic_test_function::jacobian_type = Eigen::Matrix2d

Type of Jacobian matrices.

Definition at line 37 of file double_cubic_test_function.h.

◆ variable_type

using num_prob_collect::roots::double_cubic_test_function::variable_type = Eigen::Vector2d

Type of variables.

Definition at line 34 of file double_cubic_test_function.h.

Member Function Documentation

◆ evaluate_on()

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

inline

Evaluate on a variable.

Parameters

[in] variable Variable.

Definition at line 44 of file double_cubic_test_function.h.

◆ jacobian()

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

inlinenodiscardnoexcept

Get Jacobian matrix.

Returns: Jacobian matrix.

Definition at line 69 of file double_cubic_test_function.h.

◆ value()

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

inlinenodiscardnoexcept

Get function value.

Returns: Function value.

Definition at line 60 of file double_cubic_test_function.h.

Member Data Documentation

◆ jacobian_

jacobian_type num_prob_collect::roots::double_cubic_test_function::jacobian_ {}

private

Jacobian matrix.

Definition at line 78 of file double_cubic_test_function.h.

◆ value_

variable_type num_prob_collect::roots::double_cubic_test_function::value_ {}

private

Function value.

Definition at line 75 of file double_cubic_test_function.h.

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

problems/include/num_prob_collect/roots/double_cubic_test_function.h

Public Types

Public Member Functions

Private Attributes