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

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

#include <num_collect/opt/impl/adc_rectangle.h>

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

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

Public Types
using	ternary_vector_type = TernaryVector
	Type of ternary vectors.
using	value_type = Value
	Type of function values.

Public Member Functions
	adc_rectangle (const ternary_vector_type &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_type, ternary_vector_type >
	Determine sampling points.
auto	vertex () const -> const ternary_vector_type &
	Get the vertex with lower first component.

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

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

Private Attributes
value_type	ave_value_
	Average function value.
ternary_vector_type	vertex_
	A vertex with lower first component.

Detailed Description

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

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

Template Parameters

Value	Type of function values.
TernaryVector	Type of ternary vectors.

Definition at line 40 of file adc_rectangle.h.

Member Typedef Documentation

ternary_vector_type

template<base::concepts::real_scalar Value, typename TernaryVector>

using num_collect::opt::impl::adc_rectangle< Value, TernaryVector >::ternary_vector_type = TernaryVector

Type of ternary vectors.

Definition at line 46 of file adc_rectangle.h.

value_type

template<base::concepts::real_scalar Value, typename TernaryVector>

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

Type of function values.

Definition at line 43 of file adc_rectangle.h.

Constructor & Destructor Documentation

adc_rectangle()

template<base::concepts::real_scalar Value, typename TernaryVector>

num_collect::opt::impl::adc_rectangle< Value, TernaryVector >::adc_rectangle ( const ternary_vector_type & 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 54 of file adc_rectangle.h.

Member Function Documentation

ave_value()

template<base::concepts::real_scalar Value, typename TernaryVector>

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

inlinenodiscard

Get the average function value.

Returns

Average function value.

Definition at line 72 of file adc_rectangle.h.

determine_sample_points()

template<base::concepts::real_scalar Value, typename TernaryVector>

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

inlinestaticnodiscard

Determine sampling points.

Parameters

[in]

lowest_vertex

A vertex with lower first component.

Returns

Sampling points.

Definition at line 109 of file adc_rectangle.h.

dist()

template<base::concepts::real_scalar Value, typename TernaryVector>

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

inlinenodiscard

Get the distance between center point and vertex.

Returns

Distance between center point and vertex.

Definition at line 91 of file adc_rectangle.h.

normalize_point()

template<base::concepts::real_scalar Value, typename TernaryVector>

static void num_collect::opt::impl::adc_rectangle< Value, TernaryVector >::normalize_point ( ternary_vector_type & point )

inlinestaticprivate

Normalize point.

Parameters

[in,out]

point

Point.

Definition at line 150 of file adc_rectangle.h.

sample_points()

template<base::concepts::real_scalar Value, typename TernaryVector>

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

inlinenodiscard

Determine sampling points.

Returns

Sampling points.

Definition at line 81 of file adc_rectangle.h.

vertex()

template<base::concepts::real_scalar Value, typename TernaryVector>

auto num_collect::opt::impl::adc_rectangle< Value, TernaryVector >::vertex ( ) const -> const ternary_vector_type&

inlinenodiscard

Get the vertex with lower first component.

Returns

A vertex with lower first component.

Definition at line 63 of file adc_rectangle.h.

Member Data Documentation

ave_value_

template<base::concepts::real_scalar Value, typename TernaryVector>

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

private

Average function value.

Definition at line 171 of file adc_rectangle.h.

vertex_

template<base::concepts::real_scalar Value, typename TernaryVector>

ternary_vector_type num_collect::opt::impl::adc_rectangle< Value, TernaryVector >::vertex_

private

A vertex with lower first component.

Definition at line 168 of file adc_rectangle.h.

---

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

• include/num_collect/opt/impl/adc_rectangle.h