num_collect::opt::impl::adc_rectangle< Value > Class Template Reference

Class of rectangles as proposed in [26] for num_collect::opt::adaptive_diagonal_curves. More...

#include <num_collect/opt/adaptive_diagonal_curves.h>

Inheritance diagram for num_collect::opt::impl::adc_rectangle< Value >:

Collaboration diagram for num_collect::opt::impl::adc_rectangle< Value >:

Public Types
using	value_type = Value
	Type of function values.

Public Member Functions
	adc_rectangle (const impl::ternary_vector &vertex, const value_type &ave_value)
	Constructor.
auto	ave_value () const -> const value_type &
	Get the average function value.
auto	dist () const -> value_type
	Get the distance between center point and vertex.
auto	sample_points () const -> std::pair< ternary_vector, ternary_vector >
	Determine sampling points.
auto	vertex () const -> const impl::ternary_vector &
	Get the vertex with lower first component.

Static Public Member Functions
static auto	determine_sample_points (const ternary_vector &lowest_vertex) -> std::pair< ternary_vector, ternary_vector >
	Determine sampling points.

Static Private Member Functions
static void	normalize_point (ternary_vector &point)
	Normalize point.

Private Attributes
value_type	ave_value_
	Average function value.
impl::ternary_vector	vertex_
	A vertex with lower first component.

Detailed Description

template<base::concepts::real_scalar Value>
class num_collect::opt::impl::adc_rectangle< Value >

Class of rectangles as proposed in [26] for num_collect::opt::adaptive_diagonal_curves.

Template Parameters

Value

Type of function values.

Definition at line 236 of file adaptive_diagonal_curves.h.

Member Typedef Documentation

value_type

template<base::concepts::real_scalar Value>

using num_collect::opt::impl::adc_rectangle< Value >::value_type = Value

Type of function values.

Definition at line 239 of file adaptive_diagonal_curves.h.

Constructor & Destructor Documentation

adc_rectangle()

template<base::concepts::real_scalar Value>

num_collect::opt::impl::adc_rectangle< Value >::adc_rectangle ( const impl::ternary_vector & vertex, const value_type & ave_value )

inline

Constructor.

Parameters

[in]	vertex	A vertex with lower components.
[in]	ave_value	Average function value.

Definition at line 247 of file adaptive_diagonal_curves.h.

Member Function Documentation

ave_value()

template<base::concepts::real_scalar Value>

auto num_collect::opt::impl::adc_rectangle< Value >::ave_value ( ) const -> const value_type&

inlinenodiscard

Get the average function value.

Returns

Average function value.

Definition at line 265 of file adaptive_diagonal_curves.h.

determine_sample_points()

template<base::concepts::real_scalar Value>

static auto num_collect::opt::impl::adc_rectangle< Value >::determine_sample_points ( const ternary_vector & lowest_vertex ) -> std::pair<ternary_vector, ternary_vector>

inlinestaticnodiscard

Determine sampling points.

Parameters

[in]

lowest_vertex

A vertex with lower first component.

Returns

Sampling points.

Definition at line 302 of file adaptive_diagonal_curves.h.

dist()

template<base::concepts::real_scalar Value>

auto num_collect::opt::impl::adc_rectangle< Value >::dist ( ) const -> value_type

inlinenodiscard

Get the distance between center point and vertex.

Returns

Distance between center point and vertex.

Definition at line 284 of file adaptive_diagonal_curves.h.

normalize_point()

template<base::concepts::real_scalar Value>

static void num_collect::opt::impl::adc_rectangle< Value >::normalize_point ( ternary_vector & point )

inlinestaticprivate

Normalize point.

Parameters

[in,out]

point

Point.

Definition at line 340 of file adaptive_diagonal_curves.h.

sample_points()

template<base::concepts::real_scalar Value>

auto num_collect::opt::impl::adc_rectangle< Value >::sample_points ( ) const -> std::pair<ternary_vector, ternary_vector>

inlinenodiscard

Determine sampling points.

Returns

Sampling points.

Definition at line 274 of file adaptive_diagonal_curves.h.

vertex()

template<base::concepts::real_scalar Value>

auto num_collect::opt::impl::adc_rectangle< Value >::vertex ( ) const -> const impl::ternary_vector&

inlinenodiscard

Get the vertex with lower first component.

Returns

A vertex with lower first component.

Definition at line 256 of file adaptive_diagonal_curves.h.

Member Data Documentation

ave_value_

template<base::concepts::real_scalar Value>

value_type num_collect::opt::impl::adc_rectangle< Value >::ave_value_

private

Average function value.

Definition at line 359 of file adaptive_diagonal_curves.h.

vertex_

template<base::concepts::real_scalar Value>

impl::ternary_vector num_collect::opt::impl::adc_rectangle< Value >::vertex_

private

A vertex with lower first component.

Definition at line 356 of file adaptive_diagonal_curves.h.

---

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

• include/num_collect/opt/adaptive_diagonal_curves.h