PineForge HPO 1.11.0
Native hyperparameter optimization for PineForge strategies
Loading...
Searching...
No Matches
pineforge::hpo::ErrorArgument Class Reference

A typed JSON scalar; strings in HPO-owned arguments use closed catalog vocabularies. More...

#include <pineforge/hpo/error.hpp>

Public Types

using Value = std::variant< std::nullptr_t, bool, std::int64_t, std::uint64_t, double, std::string >
 Supported scalar types, including exact signed and unsigned persistence integers.
 

Public Member Functions

 ErrorArgument (std::nullptr_t value)
 Constructs a null argument.
 
 ErrorArgument (bool value)
 Constructs a Boolean argument.
 
 ErrorArgument (std::int64_t value)
 Constructs a signed integer argument.
 
 ErrorArgument (std::uint64_t value)
 Constructs an unsigned integer argument.
 
 ErrorArgument (double value)
 Constructs a numeric argument.
 
 ErrorArgument (const char *value)
 Constructs a string argument without converting string literals to Boolean.
 
 ErrorArgument (std::string value)
 Constructs a string argument.
 
const Value & value () const noexcept
 Returns the scalar value.
 

Detailed Description

A typed JSON scalar; strings in HPO-owned arguments use closed catalog vocabularies.

Definition at line 17 of file error.hpp.

Member Typedef Documentation

◆ Value

using pineforge::hpo::ErrorArgument::Value = std::variant<std::nullptr_t, bool, std::int64_t, std::uint64_t, double, std::string>

Supported scalar types, including exact signed and unsigned persistence integers.

Definition at line 20 of file error.hpp.

Constructor & Destructor Documentation

◆ ErrorArgument() [1/7]

pineforge::hpo::ErrorArgument::ErrorArgument ( std::nullptr_t  value)
inline

Constructs a null argument.

Definition at line 23 of file error.hpp.

◆ ErrorArgument() [2/7]

pineforge::hpo::ErrorArgument::ErrorArgument ( bool  value)
inline

Constructs a Boolean argument.

Definition at line 25 of file error.hpp.

◆ ErrorArgument() [3/7]

pineforge::hpo::ErrorArgument::ErrorArgument ( std::int64_t  value)
inline

Constructs a signed integer argument.

Definition at line 27 of file error.hpp.

◆ ErrorArgument() [4/7]

pineforge::hpo::ErrorArgument::ErrorArgument ( std::uint64_t  value)
inline

Constructs an unsigned integer argument.

Definition at line 29 of file error.hpp.

◆ ErrorArgument() [5/7]

pineforge::hpo::ErrorArgument::ErrorArgument ( double  value)
inline

Constructs a numeric argument.

Definition at line 31 of file error.hpp.

◆ ErrorArgument() [6/7]

pineforge::hpo::ErrorArgument::ErrorArgument ( const char *  value)
inline

Constructs a string argument without converting string literals to Boolean.

Definition at line 33 of file error.hpp.

◆ ErrorArgument() [7/7]

pineforge::hpo::ErrorArgument::ErrorArgument ( std::string  value)
inline

Constructs a string argument.

Definition at line 35 of file error.hpp.

Member Function Documentation

◆ value()

const Value & pineforge::hpo::ErrorArgument::value ( ) const
inlinenoexcept

Returns the scalar value.

Definition at line 37 of file error.hpp.


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