autoware::common::optimization::ComputeMode Class Reference

#include <utils.hpp>

Public Member Functions
	ComputeMode ()=default
	Constructor. More...
	ComputeMode (bool8_t score, bool8_t jacobian, bool8_t hessian)
ComputeMode &	set_score () noexcept
ComputeMode &	set_jacobian () noexcept
ComputeMode &	set_hessian () noexcept
bool8_t	score () const noexcept
bool8_t	jacobian () const noexcept
bool8_t	hessian () const noexcept
bool8_t	operator== (const ComputeMode &other) const noexcept
bool8_t	operator!= (const ComputeMode &other) const noexcept

Detailed Description

Configuration class to sepcify which terms should get computed during the evaluation of an expression. By default all terms default to false. Terms to be computed should be enabled/set by either the constructor or the setter methods.

Constructor & Destructor Documentation

ComputeMode() [1/2]

autoware::common::optimization::ComputeMode::ComputeMode ( )

default

Constructor.

ComputeMode() [2/2]

autoware::common::optimization::ComputeMode::ComputeMode	(	bool8_t	score,
		bool8_t	jacobian,
		bool8_t	hessian
	)

Constructor with initial values.

Parameters

score	True if score is to be computed.
jacobian	True if jacobian is to be computed.
hessian	True if hessian is to be computed.

Member Function Documentation

hessian()

bool8_t autoware::common::optimization::ComputeMode::hessian ( ) const

noexcept

Get if hessian term is enabled.

Returns

True if hessian term is enabled.

jacobian()

bool8_t autoware::common::optimization::ComputeMode::jacobian ( ) const

noexcept

Get if jacobian term is enabled.

Returns

True if jacobian term is enabled.

operator!=()

bool8_t autoware::common::optimization::ComputeMode::operator!= ( const ComputeMode &  other ) const

noexcept

operator==()

bool8_t autoware::common::optimization::ComputeMode::operator== ( const ComputeMode &  other ) const

noexcept

score()

bool8_t autoware::common::optimization::ComputeMode::score ( ) const

noexcept

Get if score term is enabled.

Returns

True if score term is enabled.

set_hessian()

ComputeMode & autoware::common::optimization::ComputeMode::set_hessian ( )

noexcept

Set hessian to true, return the new state for method chaining.

Returns

Current modified instance.

set_jacobian()

ComputeMode & autoware::common::optimization::ComputeMode::set_jacobian ( )

noexcept

Set jacobian to true, return the new state for method chaining.

Returns

Current modified instance.

set_score()

ComputeMode & autoware::common::optimization::ComputeMode::set_score ( )

noexcept

Set score to true, return the new state for method chaining.

Returns

Current modified instance.

---

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

• common/optimization/include/optimization/utils.hpp
• utils.cpp