Named scalar feasibility constraint with an absolute non-negative tolerance. More...

#include <pineforge/hpo/objective.hpp>

Public Member Functions
bool	satisfied () const noexcept
	Returns whether all operands are finite and the relation holds.

double	violation () const noexcept
	Returns zero when satisfied and the positive violation magnitude otherwise.

Public Attributes
std::string	name
	User-facing constraint identifier.

double	lhs = 0.0
	Evaluated left-hand side.

ConstraintRelation	relation = ConstraintRelation::LessEqual
	Required comparison relation.

double	rhs = 0.0
	Configured right-hand side.

double	tolerance = 0.0
	Absolute tolerance; negative values are treated as zero.

Detailed Description

Named scalar feasibility constraint with an absolute non-negative tolerance.

Definition at line 119 of file objective.hpp.

Member Function Documentation

◆ satisfied()

bool pineforge::hpo::Constraint::satisfied ( ) const

noexcept

Returns whether all operands are finite and the relation holds.

◆ violation()

double pineforge::hpo::Constraint::violation ( ) const

noexcept

Returns zero when satisfied and the positive violation magnitude otherwise.

Non-finite input returns positive infinity so an optimizer cannot treat it as feasible.

Member Data Documentation

◆ lhs

double pineforge::hpo::Constraint::lhs = 0.0

Evaluated left-hand side.

Definition at line 123 of file objective.hpp.

◆ name

std::string pineforge::hpo::Constraint::name

User-facing constraint identifier.

Definition at line 121 of file objective.hpp.

◆ relation

ConstraintRelation pineforge::hpo::Constraint::relation = ConstraintRelation::LessEqual

Required comparison relation.

Definition at line 125 of file objective.hpp.

◆ rhs

double pineforge::hpo::Constraint::rhs = 0.0

Configured right-hand side.

Definition at line 127 of file objective.hpp.

◆ tolerance

double pineforge::hpo::Constraint::tolerance = 0.0

Absolute tolerance; negative values are treated as zero.

Definition at line 129 of file objective.hpp.

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

objective.hpp

Public Member Functions

Public Attributes