openModeller  Version 1.5.0
GarpBestSubsets Class Reference

#include <garp_best_subsets.hh>

Inheritance diagram for GarpBestSubsets:
Inheritance graph
Collaboration diagram for GarpBestSubsets:
Collaboration graph

Public Member Functions

 GarpBestSubsets ()
 
virtual ~GarpBestSubsets ()
 
- Public Member Functions inherited from BestSubsets
 BestSubsets (AlgMetadata *metadata)
 
virtual ~BestSubsets ()
 
int initialize ()
 
int iterate ()
 
int done () const
 
float getProgress () const
 
Scalar getValue (const Sample &x) const
 
int getConvergence (Scalar *const val) const
 
void printListOfRuns (string msg, AlgorithmRun **runs, int numOfRuns)
 
- Public Member Functions inherited from AlgorithmImpl
 AlgorithmImpl (AlgMetadata const *metadata)
 
virtual ~AlgorithmImpl ()
 
void setParameters (int nparam, AlgParameter const *param)
 
void setParameters (const ParamSetType &)
 
std::string const getID () const
 
AlgMetadata const * getMetadata () const
 
AlgorithmPtr getFreshCopy ()
 
virtual int supportsModelProjection () const
 
Model createModel (const SamplerPtr &samp, CallbackWrapper *func=0)
 
void setSampler (const SamplerPtr &samp)
 
virtual int finalize ()
 
virtual int needNormalization ()
 
NormalizergetNormalizer () const
 
void setNormalization (const SamplerPtr &samp) const
 
void setNormalization (const EnvironmentPtr &env) const
 
virtual Model getModel () const
 
ConfigurationPtr getConfiguration () const
 
void setConfiguration (const ConstConfigurationPtr &)
 
- Public Member Functions inherited from Configurable
virtual ~Configurable ()
 
- Public Member Functions inherited from BSAlgorithmFactory
virtual ~BSAlgorithmFactory ()
 

Private Member Functions

AlgorithmImplgetBSAlgorithm ()
 
int transferParametersToAlgorithm ()
 

Private Attributes

int _max_gen
 
int _popsize
 
int _resamples
 
double _conv_limit
 

Additional Inherited Members

- Public Types inherited from AlgorithmImpl
typedef std::map< icstring,
std::string > 
ParamSetType
 
- Protected Member Functions inherited from BestSubsets
void _getConfiguration (ConfigurationPtr &) const
 
void _setConfiguration (const ConstConfigurationPtr &)
 
- Protected Member Functions inherited from AlgorithmImpl
int dimDomain ()
 
int getParameter (std::string const &name, std::string *value)
 
int getParameter (std::string const &name, double *value)
 
int getParameter (std::string const &name, float *value)
 
int getParameter (std::string const &name, int *value)
 
- Protected Attributes inherited from BestSubsets
int _nparam
 
AlgParameter_alg_params
 
- Protected Attributes inherited from AlgorithmImpl
SamplerPtr _samp
 
Normalizer_normalizerPtr
 
ParamSetType _param
 

Detailed Description

Declaration of GARP with Best Subsets Procedure

Author
Ricardo Scachetti Pereira (rpere.nosp@m.ira@.nosp@m.ku.ed.nosp@m.u)
Date
2004-08-24
Id:
garp_best_subsets.hh 5844 2013-08-22 15:16:12Z rdg

LICENSE INFORMATION

Copyright(c), The Center for Research, University of Kansas, 2385 Irving Hill Road, Lawrence, KS 66044-4755, USA.

http://www.nhm.ku.edu

This program is free software; you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation; either version 2 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details:

http://www.gnu.org/copyleft/gpl.html Implements GARP with Best Subset Procedure (Anderson et al. 2003).

It runs "n" Garp models, filter the best ones based on the procedure defined by Anderson et al. 2003 and sum them to obtain a probability map for the species distribution.

Current implementation uses multi-threading to run multiple Garp runs in parallel. Takes advantage of multi-processor servers and workstations.

Definition at line 53 of file garp_best_subsets.hh.

Constructor & Destructor Documentation

GarpBestSubsets::GarpBestSubsets ( )

Definition at line 332 of file garp_best_subsets.cpp.

References AlgorithmImpl::_normalizerPtr.

GarpBestSubsets::~GarpBestSubsets ( )
virtual

Definition at line 339 of file garp_best_subsets.cpp.

Member Function Documentation

AlgorithmImpl * GarpBestSubsets::getBSAlgorithm ( )
privatevirtual

Implements BestSubsets.

Definition at line 344 of file garp_best_subsets.cpp.

int GarpBestSubsets::transferParametersToAlgorithm ( )
privatevirtual

Member Data Documentation

double GarpBestSubsets::_conv_limit
private

Minimum value for convergence that triggers termination of execution

Definition at line 78 of file garp_best_subsets.hh.

Referenced by transferParametersToAlgorithm().

int GarpBestSubsets::_max_gen
private

Maximum number of iterations to be executed (if convergence is not reached)

Definition at line 69 of file garp_best_subsets.hh.

Referenced by transferParametersToAlgorithm().

int GarpBestSubsets::_popsize
private

Number of points to be considered after resampling (with replacement)

Definition at line 72 of file garp_best_subsets.hh.

Referenced by transferParametersToAlgorithm().

int GarpBestSubsets::_resamples
private

Number of points to be considered after resampling (with replacement)

Definition at line 75 of file garp_best_subsets.hh.

Referenced by transferParametersToAlgorithm().


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