File IntListDescriptor.h

Copyright

This code is licensed under the 3-clause BSD license.

Copyright ETH Zurich, Laboratory for Physical Chemistry, Reiher Group.

See LICENSE.txt for details.

namespace Scine

This header file contains functions that allow for common notation for common things that can be done at a different degree of derivatives.

This header contains alias definitions defining which classes to use for the different degrees of derivatives.

namespace Utils
namespace UniversalSettings
class IntListDescriptor : public Scine::Utils::UniversalSettings::SettingDescriptor
#include <IntListDescriptor.h>

SettingDescriptor for a list of integer values.

Public Types

using IntList = GenericValue::IntList

Public Functions

IntListDescriptor(std::string propertyDescription)

Constructor.

Parameters

  • propertyDescription: A string describing what the list of integers is for

std::unique_ptr<SettingDescriptor> clone() const

Create a heap-allocated base pointer copy of this instance.

Return

A heap-allocated copy of this instance

GenericValue getDefaultGenericValue() const

Creates a type-erased representation of the setting’s default value.

Return

A type-erased representation of the setting’s default value

bool validValue(const GenericValue &v) const

Checks if a particular type-erased representation of a setting is a valid value for this kind of setting.

Return

Whether the type-erased representation is a valid value for this kind of setting

Parameters

  • v: A type-erased setting representation

bool validValue(IntList v) const
IntListDescriptor::IntList getDefaultValue() const

Get the default list of integers.

void setDefaultValue(IntList def)

Set the default list of integers.

int getDefaultItemValue() const

Returns the default value for an item in the integer list.

void setDefaultItemValue(int def)

Set the default value for each item in the integer list.

int getItemMinimum() const

Returns the lower bound for each value in the integer list.

void setItemMinimum(int min)

Set the lower bound for each value in the integer list.

int getItemMaximum() const

Returns the upper bound for each value in the integer list.

void setItemMaximum(int max)

Set the upper bound for each value in the integer list.

Private Members

int itemMinimum_
int itemMaximum_
int defaultItemValue_
IntList defaultValue_ = {}