ParallelAnalogEnsemble
Public Member Functions | Protected Member Functions | Protected Attributes | Friends | List of all members
AnEn Class Referenceabstract

AnEn is an abstract class that defines the interface for implement analog ensemble generation. More...

#include <AnEn.h>

Inheritance diagram for AnEn:
Inheritance graph
Collaboration diagram for AnEn:
Collaboration graph

Public Member Functions

 AnEn ()
 
 AnEn (const AnEn &orig)
 
 AnEn (const Config &)
 
virtual ~AnEn ()
 
virtual void compute (const Forecasts &forecasts, const Observations &observations, const Times &test_times, const Times &search_times)=0
 
virtual void compute (const Forecasts &forecasts, const Observations &observations, std::vector< std::size_t > &fcsts_test_index, std::vector< std::size_t > &fcsts_search_index)=0
 
virtual const ProfilergetProfile () const
 
virtual void print (std::ostream &) const
 
AnEnoperator= (const AnEn &rhs)
 

Protected Member Functions

virtual void setMembers_ (const Config &)
 

Protected Attributes

Verbose verbose_
 
Profiler profiler_
 

Friends

std::ostream & operator<< (std::ostream &, const AnEn &)
 

Detailed Description

AnEn is an abstract class that defines the interface for implement analog ensemble generation.

Constructor & Destructor Documentation

◆ AnEn() [1/3]

AnEn::AnEn ( )

◆ AnEn() [2/3]

AnEn::AnEn ( const AnEn orig)

◆ AnEn() [3/3]

AnEn::AnEn ( const Config config)

◆ ~AnEn()

AnEn::~AnEn ( )
virtual

Member Function Documentation

◆ compute() [1/2]

virtual void AnEn::compute ( const Forecasts forecasts,
const Observations observations,
const Times test_times,
const Times search_times 
)
pure virtual

Computes the analog ensembles.

Parameters
forecastsForecasts
observationsObservations
test_timesTimes for test
search_timesTimes for search

Implemented in AnEnIS.

◆ compute() [2/2]

virtual void AnEn::compute ( const Forecasts forecasts,
const Observations observations,
std::vector< std::size_t > &  fcsts_test_index,
std::vector< std::size_t > &  fcsts_search_index 
)
pure virtual

Computes the analog ensembles.

Parameters
fcsts_test_indexA vector of forecast test indices
fcsts_search_indexA vector of forecast search indices

Implemented in AnEnIS, AnEnSSEMS, AnEnSSE, and AnEnISMPI.

◆ getProfile()

const Profiler & AnEn::getProfile ( ) const
virtual

Get the profiling information. The profiler is usually used to time different components of the compute function.

◆ operator=()

AnEn & AnEn::operator= ( const AnEn rhs)

◆ print()

void AnEn::print ( std::ostream &  ) const
virtual

Reimplemented in AnEnIS, and AnEnSSE.

◆ setMembers_()

void AnEn::setMembers_ ( const Config config)
protectedvirtual

Reimplemented in AnEnIS, and AnEnSSE.

Friends And Related Function Documentation

◆ operator<<

std::ostream& operator<< ( std::ostream &  ,
const AnEn  
)
friend

Member Data Documentation

◆ profiler_

Profiler AnEn::profiler_
protected

◆ verbose_

Verbose AnEn::verbose_
protected

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