SeqAn3
The Modern C++ library for sequence analysis.
seqan3::arithmetic_range_validator Class Reference

A validator that checks whether a number is inside a given range. More...

#include <seqan3/argument_parser/validators.hpp>

+ Inheritance diagram for seqan3::arithmetic_range_validator:

Public Types

using value_type = double
 The type of value that this validator invoked upon.
 

Public Member Functions

 arithmetic_range_validator (value_type const min_, value_type const max_)
 The constructor. More...
 
std::string get_help_page_message () const
 Returns a message that can be appended to the (positional) options help page info.
 
void operator() (value_type const &cmp) const
 Tests whether cmp lies inside [min, max]. More...
 
template<std::ranges::forward_range range_type>
void operator() (range_type const &range) const
 Tests whether every element in range lies inside [min, max]. More...
 

Related Functions

(Note that these are not member functions.)

Requirements for seqan3::validator

You can expect these (meta-)functions on all types that implement seqan3::validator.

void operator() (value_type const &cmp) const
 Validates the value 'cmp' and throws a seqan3::validation_failed on failure. More...
 

Detailed Description

A validator that checks whether a number is inside a given range.

Template Parameters
option_value_typeMust be a (container of) arithmetic type(s).

On construction, the validator must receive a maximum and a minimum number. The struct than acts as a functor, that throws a seqan3::parser_invalid_argument exception whenever a given value does not lie inside the given min/max range.

int main(int argc, const char ** argv)
{
seqan3::argument_parser myparser{"Test", argc, argv}; // initialize
int myint;
myparser.add_option(myint,'i',"integer","Give me a number.",
// an exception will be thrown if the user specifies an integer
// that is not in range [2,10] (e.g. "./test_app -i 15")
try
{
myparser.parse();
}
catch (seqan3::parser_invalid_argument const & ext) // the user did something wrong
{
std::cerr << "[PARSER ERROR] " << ext.what() << "\n"; // customize your error message
return -1;
}
seqan3::debug_stream << "integer given by user passed validation: " << myint << "\n";
return 0;
}

Constructor & Destructor Documentation

◆ arithmetic_range_validator()

seqan3::arithmetic_range_validator::arithmetic_range_validator ( value_type const  min_,
value_type const  max_ 
)
inline

The constructor.

Parameters
[in]min_Minimum set for the range to test.
[in]max_Maximum set for the range to test.

Member Function Documentation

◆ operator()() [1/2]

void seqan3::arithmetic_range_validator::operator() ( value_type const &  cmp) const
inline

Tests whether cmp lies inside [min, max].

Parameters
cmpThe input value to check.
Exceptions
parser_invalid_argument

◆ operator()() [2/2]

template<std::ranges::forward_range range_type>
void seqan3::arithmetic_range_validator::operator() ( range_type const &  range) const
inline

Tests whether every element in range lies inside [min, max].

Template Parameters
range_typeThe type of range to check; must model std::ranges::forward_range. The value type must model seqan3::arithmetic.
Parameters
rangeThe input range to iterate over and check every element.
Exceptions
parser_invalid_argument

Friends And Related Function Documentation

◆ operator()()

void operator() ( value_type const &  cmp) const
related

Validates the value 'cmp' and throws a seqan3::validation_failed on failure.

Template Parameters
value_typeThe type of the value to be validated.
Parameters
[in,out]cmpThe value to be validated.
Exceptions
seqan3::validation_failedif value 'cmp' does not pass validation.
Attention
This is a concept requirement, not an actual function (however types satisfying this concept will provide an implementation).

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