ModelEvaluation Class

Namespace: Phoenix.Optimization

Overview

Class to hold the results of a model evaluation.

Inheritance

Declaration

class ModelEvaluation

Description

Class to hold the results of a model evaluation.

Public Member Functions

Type	Name	Description
	ModelEvaluation ()	Constructor
	ModelEvaluation (double[] objectiveValues)	Constructor
	ModelEvaluation (double[] objectiveValues, bool runFailure)	Constructor
	ModelEvaluation (double[] objectiveValues, double[] constraintValues, bool runFailure)	Constructor
	ModelEvaluation (ModelEvaluation eval)	Copy constructor

Properties

Type	Name	Description
double[]	ConstraintValues [get]	Double array containing the values of the constraints.
double[]	ObjectiveValues [get]	Double array containing the values of the objectives
bool	RunFailure [get]	Boolean contain stating whether the model evaluation was successful.

Constructor & Destructor Documentation

ModelEvaluation()

ModelEvaluation ( )

Constructor Constructs a failed model evaluation. This constructor primarily exists to allow ModelEvaluation to be serialized.

ModelEvaluation()

ModelEvaluation ( double[] objectiveValues)

Constructor Assumes that there are no constraints. If objectiveValues is not null then the Run is assumed to not be failed, otherwise the Run is assumed to be failed.

Parameters:

• objectiveValues - double array of objective values

ModelEvaluation()

ModelEvaluation ( double[] objectiveValues, bool runFailure )

Constructor Assumes that there are no constraints. If objectiveValues is not null, then the runFailure value is used, otherwise the Run is assumed to be failed.

Parameters:

• objectiveValues - double array of objective values
• runFailure - boolean Run failure value

ModelEvaluation()

ModelEvaluation ( double[] objectiveValues, double[] constraintValues, bool runFailure )

Constructor If objectiveValues is not null, then the runFailure value is used, otherwise the Run is assumed to be failed.

Parameters:

• objectiveValues - double array of objective values
• constraintValues - double array of constraint values
• runFailure - boolean Run failure value

ModelEvaluation()

ModelEvaluation ( ModelEvaluation eval)

Copy constructor

Parameters:

• eval - ModelEvaluation to be copied

Member Function Documentation

ConstraintValues

double [] ConstraintValues

Double array containing the values of the constraints.

ObjectiveValues

double [] ObjectiveValues

Double array containing the values of the objectives

RunFailure

bool RunFailure

Boolean contain stating whether the model evaluation was successful. The value will be true if there was an error evaluating the model, and false otherwise.

Property Documentation

ConstraintValues

double [] ConstraintValues

Double array containing the values of the constraints.

ObjectiveValues

double [] ObjectiveValues

Double array containing the values of the objectives

RunFailure

bool RunFailure

Boolean contain stating whether the model evaluation was successful. The value will be true if there was an error evaluating the model, and false otherwise.