Class representing the traversal choices. More...

#include <DataLayoutOption.h>

Inheritance diagram for autopas::options::DataLayoutOption:

[legend]

Collaboration diagram for autopas::options::DataLayoutOption:

[legend]

Public Types
enum	Value { aos , soa }
	Possible choices for the particle data layout. More...

Public Member Functions
	DataLayoutOption ()=default
	Constructor.

constexpr	DataLayoutOption (Value option)
	Constructor from value.

constexpr	operator Value () const
	Cast to value.

Public Member Functions inherited from autopas::options::Option< DataLayoutOption >
	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< DataLayoutOption >	getDiscouragedOptions ()
	Set of options that are very unlikely to be interesting.

static std::map< DataLayoutOption, std::string >	getOptionNames ()
	Provides a way to iterate over the possible choices of TraversalOption.

Static Public Member Functions inherited from autopas::options::Option< DataLayoutOption >
static std::set< DataLayoutOption >	getAllOptions ()
	Provides a way to iterate over the possible options.

static std::set< DataLayoutOption >	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 DataLayoutOption	parseOptionExact (const std::string &optionString)
	Converts a string to an enum.

Detailed Description

Class representing the traversal choices.

Member Enumeration Documentation

◆ Value

enum autopas::options::DataLayoutOption::Value

Possible choices for the particle data layout.

Enumerator
aos	Array of structure (AoS) : Particles are stored as Objects in a vector.
soa	Structure of arrays (SoA) : One Vector for each particle property.

Constructor & Destructor Documentation

◆ DataLayoutOption()

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

inlineconstexpr

Constructor from value.

Parameters

option

Member Function Documentation

◆ getDiscouragedOptions()

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

inlinestatic

Set of options that are very unlikely to be interesting.

Returns

◆ getOptionNames()

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

inlinestatic

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

Returns: map option -> string representation

◆ operator Value()

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

inlineconstexpr

Cast to value.

Returns

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

autopas/options/DataLayoutOption.h

Public Types

Public Member Functions

Static Public Member Functions