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

Class of groups in [27] for num_collect::opt::adaptive_diagonal_curves. More...

#include <num_collect/opt/adaptive_diagonal_curves.h>

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

Classes
struct	greater
	Class to compare rectangles. More...

Public Types
using	rectangle_pointer_type = std::shared_ptr<rectangle_type>
	Type of pointers of hyper-rectangles.
using	rectangle_type = adc_rectangle<value_type>
	Type of hyper-rectangles.
using	value_type = Value
	Type of function values.

Public Member Functions
	adc_group (value_type dist)
	Constructor.
auto	dist () const -> const value_type &
	Get the distance between center point and vertex.
auto	empty () const -> bool
	Check whether this group is empty.
auto	min_rect () const -> const rectangle_pointer_type &
	Access the hyper-rectangle with the smallest average of function values at diagonal vertices.
auto	pop () -> rectangle_pointer_type
	Pick out the hyper-rectangle with the smallest average of function values at diagonal vertices.
void	push (rectangle_pointer_type rect)
	Add a hyper-rectangle to this group.

Private Types
using	queue_type
	Type of queues of rectangles.

Private Attributes
value_type	dist_
	Distance between center point and vertex.
queue_type	rects_ {}
	Rectangles.

Detailed Description

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

Class of groups in [27] for num_collect::opt::adaptive_diagonal_curves.

Template Parameters

Value

Type of function values.

Definition at line 369 of file adaptive_diagonal_curves.h.

Member Typedef Documentation

queue_type

template<base::concepts::real_scalar Value>

using num_collect::opt::impl::adc_group< Value >::queue_type

private

Initial value:

 std::priority_queue<rectangle_pointer_type,
        std::vector<rectangle_pointer_type>, greater>

Type of queues of rectangles.

Definition at line 454 of file adaptive_diagonal_curves.h.

rectangle_pointer_type

template<base::concepts::real_scalar Value>

using num_collect::opt::impl::adc_group< Value >::rectangle_pointer_type = std::shared_ptr<rectangle_type>

Type of pointers of hyper-rectangles.

Definition at line 378 of file adaptive_diagonal_curves.h.

rectangle_type

template<base::concepts::real_scalar Value>

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

Type of hyper-rectangles.

Definition at line 375 of file adaptive_diagonal_curves.h.

value_type

template<base::concepts::real_scalar Value>

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

Type of function values.

Definition at line 372 of file adaptive_diagonal_curves.h.

Constructor & Destructor Documentation

adc_group()

template<base::concepts::real_scalar Value>

num_collect::opt::impl::adc_group< Value >::adc_group ( value_type dist )

inlineexplicit

Constructor.

Parameters

[in]

dist

Distance between center point and vertex.

Definition at line 385 of file adaptive_diagonal_curves.h.

Member Function Documentation

dist()

template<base::concepts::real_scalar Value>

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

inlinenodiscard

Get the distance between center point and vertex.

Returns

Distance between center point and vertex.

Definition at line 433 of file adaptive_diagonal_curves.h.

empty()

template<base::concepts::real_scalar Value>

auto num_collect::opt::impl::adc_group< Value >::empty ( ) const -> bool

inlinenodiscard

Check whether this group is empty.

Returns

Whether this group is empty.

Definition at line 413 of file adaptive_diagonal_curves.h.

min_rect()

template<base::concepts::real_scalar Value>

auto num_collect::opt::impl::adc_group< Value >::min_rect ( ) const -> const rectangle_pointer_type&

inlinenodiscard

Access the hyper-rectangle with the smallest average of function values at diagonal vertices.

Returns

Reference of pointer to the rectangle.

Definition at line 403 of file adaptive_diagonal_curves.h.

pop()

template<base::concepts::real_scalar Value>

auto num_collect::opt::impl::adc_group< Value >::pop ( ) -> rectangle_pointer_type

inlinenodiscard

Pick out the hyper-rectangle with the smallest average of function values at diagonal vertices.

Returns

Rectangle.

Definition at line 421 of file adaptive_diagonal_curves.h.

push()

template<base::concepts::real_scalar Value>

void num_collect::opt::impl::adc_group< Value >::push ( rectangle_pointer_type rect )

inline

Add a hyper-rectangle to this group.

Parameters

[in]

rect

Rectangle.

Definition at line 392 of file adaptive_diagonal_curves.h.

Member Data Documentation

dist_

template<base::concepts::real_scalar Value>

value_type num_collect::opt::impl::adc_group< Value >::dist_

private

Distance between center point and vertex.

Definition at line 461 of file adaptive_diagonal_curves.h.

rects_

template<base::concepts::real_scalar Value>

queue_type num_collect::opt::impl::adc_group< Value >::rects_ {}

private

Rectangles.

Definition at line 458 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