num_collect::ode::step_size_limits< Scalar > Class Template Reference

Class of limits of step sizes. More...

#include <num_collect/ode/step_size_limits.h>

Inheritance diagram for num_collect::ode::step_size_limits< Scalar >:

Collaboration diagram for num_collect::ode::step_size_limits< Scalar >:

Public Types
using	scalar_type = Scalar
	Type of scalars.

Public Member Functions
constexpr	step_size_limits ()=default
	Constructor.
auto	apply (scalar_type val) const -> scalar_type
	Apply the limit of this object.
auto	lower_limit () const -> const scalar_type &
	Get the lower limit.
auto	lower_limit (const scalar_type &val) -> step_size_limits &
	Set the lower limit.
auto	upper_limit () const -> const scalar_type &
	Get the upper limit.
auto	upper_limit (const scalar_type &val) -> step_size_limits &
	Set the upper limit.

Private Attributes
scalar_type	lower_limit_ {impl::default_step_size_lower_limit<scalar_type>}
	Lower limit.
scalar_type	upper_limit_ {impl::default_step_size_upper_limit<scalar_type>}
	Upper limit.

Detailed Description

template<base::concepts::real_scalar Scalar>
class num_collect::ode::step_size_limits< Scalar >

Class of limits of step sizes.

Template Parameters

Scalar

Type of scalars.

Definition at line 59 of file step_size_limits.h.

Member Typedef Documentation

scalar_type

template<base::concepts::real_scalar Scalar>

using num_collect::ode::step_size_limits< Scalar >::scalar_type = Scalar

Type of scalars.

Definition at line 62 of file step_size_limits.h.

Member Function Documentation

apply()

template<base::concepts::real_scalar Scalar>

auto num_collect::ode::step_size_limits< Scalar >::apply ( scalar_type val ) const -> scalar_type

inlinenodiscard

Apply the limit of this object.

Parameters

[in]

val

Value to apply the limit.

Returns

Resulting value.

Definition at line 75 of file step_size_limits.h.

lower_limit() [1/2]

template<base::concepts::real_scalar Scalar>

auto num_collect::ode::step_size_limits< Scalar >::lower_limit ( ) const -> const scalar_type&

inlinenodiscard

Get the lower limit.

Returns

Value.

Definition at line 99 of file step_size_limits.h.

lower_limit() [2/2]

template<base::concepts::real_scalar Scalar>

auto num_collect::ode::step_size_limits< Scalar >::lower_limit ( const scalar_type & val ) -> step_size_limits&

inline

Set the lower limit.

Parameters

[in]

val

Value.

Returns

This.

Definition at line 122 of file step_size_limits.h.

upper_limit() [1/2]

template<base::concepts::real_scalar Scalar>

auto num_collect::ode::step_size_limits< Scalar >::upper_limit ( ) const -> const scalar_type&

inlinenodiscard

Get the upper limit.

Returns

Value.

Definition at line 90 of file step_size_limits.h.

upper_limit() [2/2]

template<base::concepts::real_scalar Scalar>

auto num_collect::ode::step_size_limits< Scalar >::upper_limit ( const scalar_type & val ) -> step_size_limits&

inline

Set the upper limit.

Parameters

[in]

val

Value.

Returns

This.

Definition at line 109 of file step_size_limits.h.

Member Data Documentation

lower_limit_

template<base::concepts::real_scalar Scalar>

scalar_type num_collect::ode::step_size_limits< Scalar >::lower_limit_ {impl::default_step_size_lower_limit<scalar_type>}

private

Lower limit.

Definition at line 135 of file step_size_limits.h.

upper_limit_

template<base::concepts::real_scalar Scalar>

scalar_type num_collect::ode::step_size_limits< Scalar >::upper_limit_ {impl::default_step_size_upper_limit<scalar_type>}

private

Upper limit.

Definition at line 132 of file step_size_limits.h.

---

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

• include/num_collect/ode/step_size_limits.h