Class Paramita::RealParameter

Represents a floating-point parameter with range constraints.

The domain is an inclusive Range.

• #include <ParameterSpace.hpp>

Inherits the following classes: Paramita::Parameter

Public Functions

Type	Name
	RealParameter (float default_value, Range< float > range) Construct a new real parameter.
	RealParameter (const RealParameter &)
	RealParameter (RealParameter &&) noexcept
virtual ParameterType	default_value () override const The default value for this parameter.
virtual bool	is_valid (ParameterType value) override const Checks that the value is in the domain and has the correct type.
float	max_value () const
float	min_value () const
RealParameter &	operator= (const RealParameter &) = delete
RealParameter &	operator= (RealParameter &&) = delete
	~RealParameter () override

Public Functions inherited from Paramita::Parameter

See Paramita::Parameter

Type	Name
	Parameter () = default
	Parameter (const Parameter &) = delete Deleted constructor (pure interface).
	Parameter (Parameter &&) = delete Deleted constructor (pure interface).
virtual ParameterType	default_value () const = 0 The default value for this parameter.
virtual bool	is_valid (ParameterType value) const = 0 Checks that the value is in the domain and has the correct type.
Parameter &	operator= (const Parameter & container) = delete Deleted constructor (pure interface).
Parameter &	operator= (Parameter &&) = delete Deleted constructor (pure interface).
virtual	~Parameter () = default

Public Functions Documentation

function RealParameter [1/3]

Construct a new real parameter.

inline Paramita::RealParameter::RealParameter (
    float default_value,
    Range < float > range
) 

Parameters:

• default_value The default floating-point value used when not specified.
• range The range of valid values.

---

function RealParameter [2/3]

Paramita::RealParameter::RealParameter (
    const RealParameter &
) 

---

function RealParameter [3/3]

Paramita::RealParameter::RealParameter (
    RealParameter &&
) noexcept

---

function default_value

The default value for this parameter.

virtual ParameterType Paramita::RealParameter::default_value () override const

Returns:

The default value.

Implements Paramita::Parameter::default_value

---

function is_valid

Checks that the value is in the domain and has the correct type.

virtual bool Paramita::RealParameter::is_valid (
    ParameterType value
) override const

Parameters:

• value The value to check.

Returns:

True if the value is valid.

Implements Paramita::Parameter::is_valid

---

function max_value

float Paramita::RealParameter::max_value () const

---

function min_value

float Paramita::RealParameter::min_value () const

---

function operator=

RealParameter & Paramita::RealParameter::operator= (
    const RealParameter &
) = delete

---

function operator=

RealParameter & Paramita::RealParameter::operator= (
    RealParameter &&
) = delete

---

function ~RealParameter

Paramita::RealParameter::~RealParameter () override

---