Defines the risk factor allowed range data type. More...

#include <mapping.h>

Public Member Functions
	FactorRange ()=default
	Initialises a new instance of the FactorRange structure. More...

	FactorRange (double min_value, double max_value)
	Initialises a new instance of the FactorRange structure. More...

Public Attributes
bool	empty {true}
	Gets a value indicating whether the range is empty, no limits. More...

double	minimum {}
	The range minimum value. More...

double	maximum {}
	The range maximum value. More...

Detailed Description

Defines the risk factor allowed range data type.

The factors range is defined from the fitted dataset and enforced by the simulation algorithm. The default constructor, creates an empty range.

Constructor & Destructor Documentation

hgps::FactorRange::FactorRange ( )

default

Initialises a new instance of the FactorRange structure.

hgps::FactorRange::FactorRange	(	double	min_value,
		double	max_value
	)

inline

Initialises a new instance of the FactorRange structure.

Parameters

min_value	Minimum factor value
max_value	Maximum factor value

Exceptions

std::invalid_argument for minimum greater than the maximum value

bool hgps::FactorRange::empty {true}

Gets a value indicating whether the range is empty, no limits.

double hgps::FactorRange::maximum {}

The range maximum value.

double hgps::FactorRange::minimum {}

The range minimum value.

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