autopas::options::SortingDirectionOption Class Reference

Class representing the classification of a normalized cell-pair sortingDirection by the number of its zero components. More...

#include <SortingDirectionOption.h>

Inheritance diagram for autopas::options::SortingDirectionOption:

Collaboration diagram for autopas::options::SortingDirectionOption:

Public Types
enum	Value : size_t { corner = 0 , edge = 1 , face = 2 }
	Possible choices for the direction-type classification, indexed by the number of zero components in the normalized sortingDirection. More...

Public Member Functions
	SortingDirectionOption ()=default
	Constructor.
constexpr	SortingDirectionOption (Value option)
	Constructor from value.
constexpr	operator Value () const
	Cast to value.
Public Member Functions inherited from autopas::options::Option< SortingDirectionOption >
	operator bool ()=delete
	Prevents cast to bool by deleting the conversion operator.
std::string	to_string (bool fixedLength=false) const
	Converts an Option object to its respective string representation.

Static Public Member Functions
static std::set< SortingDirectionOption >	getDiscouragedOptions ()
	Set of options that are very unlikely to be interesting.
static std::map< SortingDirectionOption, std::string >	getOptionNames ()
	Provides a way to iterate over the possible choices of SortingDirectionOption.
static SortingDirectionOption	fromRawArray (const std::array< double, 3 > &sortingDirection)
	Classifies a normalized sortingDirection by its number of zero components.
Static Public Member Functions inherited from autopas::options::Option< SortingDirectionOption >
static std::set< SortingDirectionOption >	getAllOptions ()
	Provides a way to iterate over the possible options.
static std::set< SortingDirectionOption >	getMostOptions ()
	Provides a way to iterate over the possible options minus those that are very unlikely to be on interest.
static size_t	maxStringLength ()
	Returns the number of characters in the string representation of the longest option.
static OutputContainer	parseOptions (const std::string &optionsString)
	Converts a string of options to a set of enums.
static SortingDirectionOption	parseOptionExact (const std::string &optionString)
	Converts a string to an enum.

Detailed Description

Class representing the classification of a normalized cell-pair sortingDirection by the number of its zero components.

Member Enumeration Documentation

Value

enum autopas::options::SortingDirectionOption::Value : size_t

Possible choices for the direction-type classification, indexed by the number of zero components in the normalized sortingDirection.

Enumerator
corner	All three components of sortingDirection are non-zero.
edge	Exactly one component of sortingDirection is zero.
face	Exactly two components of sortingDirection are zero.

Constructor & Destructor Documentation

SortingDirectionOption()

constexpr autopas::options::SortingDirectionOption::SortingDirectionOption ( Value  option )

inlineconstexpr

Constructor from value.

Parameters

option

Member Function Documentation

fromRawArray()

static SortingDirectionOption autopas::options::SortingDirectionOption::fromRawArray ( const std::array< double, 3 > &  sortingDirection )

inlinestatic

Classifies a normalized sortingDirection by its number of zero components.

Parameters

sortingDirection

Normalized vector connecting the centers of two cells. Must not be {0., 0., 0.}.

Returns

The corresponding SortingDirectionOption.

getDiscouragedOptions()

static std::set< SortingDirectionOption > autopas::options::SortingDirectionOption::getDiscouragedOptions ( )

inlinestatic

Set of options that are very unlikely to be interesting.

Returns

getOptionNames()

static std::map< SortingDirectionOption, std::string > autopas::options::SortingDirectionOption::getOptionNames ( )

inlinestatic

Provides a way to iterate over the possible choices of SortingDirectionOption.

Returns

map option -> string representation

operator Value()

constexpr autopas::options::SortingDirectionOption::operator Value ( ) const

inlineconstexpr

Cast to value.

Returns

---

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

• autopas/options/SortingDirectionOption.h