OpenStudioCore:analysis
 All Classes Namespaces Functions Variables Typedefs Enumerations Enumerator Pages
Related Functions | List of all members
openstudio::analysis::SequentialSearchOptions Class Reference

#include <SequentialSearchOptions.hpp>

+ Inheritance diagram for openstudio::analysis::SequentialSearchOptions:

Public Member Functions

Constructors and Destructors
 SequentialSearchOptions (int objectiveToMinimizeFirst)
 Constructor. More...
 
 SequentialSearchOptions (const std::vector< Attribute > &options)
 Constructor provided for deserialization; not for general use. More...
 
virtual ~SequentialSearchOptions ()
 
Getters and Queries
int objectiveToMinimizeFirst () const
 
- Public Member Functions inherited from openstudio::analysis::AlgorithmOptions
 AlgorithmOptions ()
 By default, maxIter and maxSims are set to boost::none (no restriction). More...
 
virtual ~AlgorithmOptions ()
 
AlgorithmOptions clone () const
 
boost::optional< int > maxIter () const
 
boost::optional< int > maxSims () const
 
std::vector< Attribute > options () const
 Getter provided for serialization; not for general use. More...
 
void setMaxIter (int maxIter)
 
void setMaxSims (int maxSims)
 
void clearMaxIter ()
 
void clearMaxSims ()
 
template<typename T >
cast () const
 Cast to type T. More...
 
template<typename T >
boost::optional< T > optionalCast () const
 Cast to boost::optional<T>. More...
 

Related Functions

(Note that these are not member functions.)

typedef boost::optional
< SequentialSearchOptions
OptionalSequentialSearchOptions
 
typedef std::vector
< SequentialSearchOptions
SequentialSearchOptionsVector
 

Additional Inherited Members

- Protected Member Functions inherited from openstudio::analysis::AlgorithmOptions
void setAlgorithm (const Algorithm &algorithm)
 
QVariant toVariant () const
 

Detailed Description

SequentialSearchOptions is an options class for SequentialSearch, derived from AlgorithmOptions.

Constructor & Destructor Documentation

openstudio::analysis::SequentialSearchOptions::SequentialSearchOptions ( int  objectiveToMinimizeFirst)
explicit

Constructor.

Required argument objectiveToMinimizeFirst is the index of the objective function (0 or 1) for which the minimum curve will be constructed. This means that the SequentialSearch algorithm will first work towards locating the point that minimizes this objective function, in the direction of also minimizing the other objective function. After achieving this minimum point, objectiveToMinimizeFirst will be allowed to increase, while the other objective function continues to be driven towards its minimum. The final MinimumCurve(objectiveToMinimizeFirst) will contain the convex hull of the overall ParetoFront; the values of objectiveToMinimizeFirst will first decrease, then increase; and the other objective function will monotonically decrease.

In NREL analyses, objectiveToMinimizeFirst typically refers to an economic objective, and the other objective function is typically an energy metric. In this way the final curve traces out minimum cost designs for each level of energy use that improves on the baseline (existing building or code minimum).

openstudio::analysis::SequentialSearchOptions::SequentialSearchOptions ( const std::vector< Attribute > &  options)
explicit

Constructor provided for deserialization; not for general use.

virtual openstudio::analysis::SequentialSearchOptions::~SequentialSearchOptions ( )
inlinevirtual

Member Function Documentation

int openstudio::analysis::SequentialSearchOptions::objectiveToMinimizeFirst ( ) const

Friends And Related Function Documentation

typedef boost::optional<SequentialSearchOptions> OptionalSequentialSearchOptions
related