autopas::NumberSetFinite< Number > Class Template Reference

Class describing a finite set of numbers. More...

#include <NumberSetFinite.h>

Inheritance diagram for autopas::NumberSetFinite< Number >:

Collaboration diagram for autopas::NumberSetFinite< Number >:

Public Member Functions
	NumberSetFinite ()
	Default Constructor: Empty set.
	NumberSetFinite (std::initializer_list< Number > values)
	Create a NumberSet of given values.
	NumberSetFinite (const std::set< Number > &values)
	Create a NumberSet from a std::set.
std::unique_ptr< NumberSet< Number > >	clone () const override
	Create a copy of a NumberSet.
void	resetValues (const std::set< Number > &numbers) override
	Setter for NumberSetFinite.
std::string	to_string () const override
	Get a string representation of the set.
bool	isEmpty () const override
	Indicates if the set is empty.
bool	isFinite () const override
	Indicates if the set is finite.
bool	isInterval () const override
	Function to distinguish between NumberSetFinite and NumberInterval.
size_t	size () const override
	Get size of set.
Number	getMin () const override
	Get the smallest number in the set.
Number	getMax () const override
	Get the largest number in the set.
std::set< Number >	getAll () const override
	Get all numbers in the set.
Number	getRandom (Random &rng) const override
	Get a random number in the set.
std::vector< Number >	uniformSample (size_t n, Random &rng) const override
	Sample n points from the set.
std::set< Number >	uniformSampleSet (size_t n, Random &rng) const override
	Sample up to n points from the set.
Number	getMedian () const override
	Get the median of the set.
bool	operator== (const NumberSet< Number > &rhs) const override
	Comparison operator.
virtual std::unique_ptr< NumberSet >	clone () const =0
	Create a copy of a NumberSet.
virtual void	resetValues (const std::set< Number > &numbers)=0
	A unified setter for all derived classes.
virtual std::string	to_string () const =0
	Get a string representation of the set.
virtual bool	isEmpty () const =0
	Indicates if the set is empty.
virtual bool	isFinite () const =0
	Indicates if the set is finite.
virtual bool	isInterval () const =0
	Function to distinguish between NumberSetFinite and NumberInterval.
virtual size_t	size () const =0
	Get size of set.
virtual Number	getMin () const =0
	Get the smallest number in the set.
virtual Number	getMax () const =0
	Get the largest number in the set.
virtual std::set< Number >	getAll () const =0
	Get all numbers in the set.
virtual Number	getRandom (Random &rng) const =0
	Get a random number in the set.
virtual std::vector< Number >	uniformSample (size_t n, Random &rng) const =0
	Sample n points from the set.
virtual std::set< Number >	uniformSampleSet (size_t n, Random &rng) const =0
	Sample up to n points from the set.
virtual Number	getMedian () const =0
	Get the median of the set.
virtual bool	operator== (const NumberSet< Number > &rhs) const =0
	Comparison operator.

Detailed Description

template<class Number>
class autopas::NumberSetFinite< Number >

Class describing a finite set of numbers.

Constructor & Destructor Documentation

NumberSetFinite() [1/2]

template<class Number >

autopas::NumberSetFinite< Number >::NumberSetFinite ( std::initializer_list< Number >  values )

inline

Create a NumberSet of given values.

Parameters

values

NumberSetFinite() [2/2]

template<class Number >

autopas::NumberSetFinite< Number >::NumberSetFinite ( const std::set< Number > &  values )

inline

Create a NumberSet from a std::set.

Parameters

values

Member Function Documentation

clone()

template<class Number >

std::unique_ptr< NumberSet< Number > > autopas::NumberSetFinite< Number >::clone ( ) const

inlineoverridevirtual

Create a copy of a NumberSet.

Returns

Implements autopas::NumberSet< Number >.

getAll()

template<class Number >

std::set< Number > autopas::NumberSetFinite< Number >::getAll ( ) const

inlineoverridevirtual

Get all numbers in the set.

Only usable if set is finite.

Returns

Implements autopas::NumberSet< Number >.

getMax()

template<class Number >

Number autopas::NumberSetFinite< Number >::getMax ( ) const

inlineoverridevirtual

Get the largest number in the set.

Returns

Implements autopas::NumberSet< Number >.

getMedian()

template<class Number >

Number autopas::NumberSetFinite< Number >::getMedian ( ) const

inlineoverridevirtual

Get the median of the set.

Returns

Implements autopas::NumberSet< Number >.

getMin()

template<class Number >

Number autopas::NumberSetFinite< Number >::getMin ( ) const

inlineoverridevirtual

Get the smallest number in the set.

Returns

Implements autopas::NumberSet< Number >.

getRandom()

template<class Number >

Number autopas::NumberSetFinite< Number >::getRandom ( Random &  rng ) const

inlineoverridevirtual

Get a random number in the set.

Parameters

rng	random number generator

Returns

Implements autopas::NumberSet< Number >.

isEmpty()

template<class Number >

bool autopas::NumberSetFinite< Number >::isEmpty ( ) const

inlineoverridevirtual

Indicates if the set is empty.

Returns

True if set is empty

Implements autopas::NumberSet< Number >.

isFinite()

template<class Number >

bool autopas::NumberSetFinite< Number >::isFinite ( ) const

inlineoverridevirtual

Indicates if the set is finite.

This includes intervals that contain exactly one value.

Returns

True if set is finite

Implements autopas::NumberSet< Number >.

isInterval()

template<class Number >

bool autopas::NumberSetFinite< Number >::isInterval ( ) const

inlineoverridevirtual

Function to distinguish between NumberSetFinite and NumberInterval.

Returns

True for NumberInterval, false for NumberSetFinite.

Implements autopas::NumberSet< Number >.

operator==()

template<class Number >

bool autopas::NumberSetFinite< Number >::operator== ( const NumberSet< Number > &  rhs ) const

inlineoverridevirtual

Comparison operator.

Parameters

rhs

Returns

Implements autopas::NumberSet< Number >.

resetValues()

template<class Number >

void autopas::NumberSetFinite< Number >::resetValues ( const std::set< Number > &  numbers )

inlineoverridevirtual

Setter for NumberSetFinite.

Parameters

numbers

The set of numbers the new NumberSetFinite represents

Implements autopas::NumberSet< Number >.

size()

template<class Number >

size_t autopas::NumberSetFinite< Number >::size ( ) const

inlineoverridevirtual

Get size of set.

Only usable if set is finite.

Returns

size of set

Implements autopas::NumberSet< Number >.

to_string()

template<class Number >

std::string autopas::NumberSetFinite< Number >::to_string ( ) const

inlineoverridevirtual

Get a string representation of the set.

Returns

string representation

Implements autopas::NumberSet< Number >.

uniformSample()

template<class Number >

std::vector< Number > autopas::NumberSetFinite< Number >::uniformSample ( size_t  n, Random &  rng  ) const

inlineoverridevirtual

Sample n points from the set.

These points are spaced evenly across the space.

Parameters

n	max samples
rng	random number generator

Returns

samples randomly ordered vector of points

Implements autopas::NumberSet< Number >.

uniformSampleSet()

template<class Number >

std::set< Number > autopas::NumberSetFinite< Number >::uniformSampleSet ( size_t  n, Random &  rng  ) const

inlineoverridevirtual

Sample up to n points from the set.

These points are spaced evenly across the space.

Parameters

n	max samples
rng	random number generator

Returns

samples ordered set of points

Implements autopas::NumberSet< Number >.

---

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

• autopas/utils/NumberSetFinite.h