openModeller  Version 1.4.0
Public Member Functions | Protected Member Functions | Private Member Functions | Private Attributes
EnvelopeScore Class Reference

#include <envelope_score.hh>

Inheritance diagram for EnvelopeScore:
Inheritance graph
[legend]
Collaboration diagram for EnvelopeScore:
Collaboration graph
[legend]

List of all members.

Public Member Functions

 EnvelopeScore ()
 ~EnvelopeScore ()
int initialize ()
int iterate ()
int done () const
Scalar getValue (const Sample &x) const
int getConvergence (Scalar *const val) const

Protected Member Functions

virtual void _getConfiguration (ConfigurationPtr &) const
virtual void _setConfiguration (const ConstConfigurationPtr &)

Private Member Functions

void computeStats (const OccurrencesPtr &)
void logEnvelope ()

Private Attributes

bool _done
Sample _minimum
 > is true if the algorithm is finished.
Sample _maximum
 > Mininum value for each variable.

Detailed Description

Declaration of EnvelopeScoreatic Envelope Algorithm - Nix, 1986.

Author:
Mauro Muñoz <mauro@cria.org.br>
EnvelopeScore_or implemantation by Tim Sutton and Chris Yesson
Date:
2007-08-22
Id:
envelope_score.hh 4419 2008-06-26 20:07:29Z rdg

LICENSE INFORMATION

Based on Bioclim alg Copyright(c) 2004 by CRIA - Centro de Referência em Informação Ambiental

http://www.cria.org.br

Envelope Score implementation (c) 2007 Chris Yesson and Tim Sutton

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 Bioclimatic Envelope Algorithm with occurrence probability based on the number variables within the min/max range

Definition at line 45 of file envelope_score.hh.

Constructor & Destructor Documentation

EnvelopeScore::EnvelopeScore ( )

Definition at line 131 of file envelope_score.cpp.

EnvelopeScore::~EnvelopeScore ( )

Definition at line 142 of file envelope_score.cpp.

Member Function Documentation

void EnvelopeScore::_getConfiguration ( ConfigurationPtr &  config) const [protected, virtual]

Reimplemented from AlgorithmImpl.

Definition at line 265 of file envelope_score.cpp.

References _done, _maximum, and _minimum.

void EnvelopeScore::_setConfiguration ( const ConstConfigurationPtr &  config) [protected, virtual]

Reimplemented from AlgorithmImpl.

Definition at line 279 of file envelope_score.cpp.

References _done, _maximum, and _minimum.

void EnvelopeScore::computeStats ( const OccurrencesPtr &  occs) [private]

compute the statistic member variables based on the data in the OccurrencesPtr

Definition at line 230 of file envelope_score.cpp.

References _maximum, and _minimum.

Referenced by initialize().

int EnvelopeScore::done ( ) const [virtual]

Return != 0 if algorithm finished.

Reimplemented from AlgorithmImpl.

Definition at line 186 of file envelope_score.cpp.

References _done.

int EnvelopeScore::getConvergence ( Scalar *const  val) const [virtual]

Returns the algorithm's convergence value at the moment

Reimplemented from AlgorithmImpl.

Definition at line 220 of file envelope_score.cpp.

Scalar EnvelopeScore::getValue ( const Sample &  x) const [virtual]

The algorithm must return the occurrence probability at the given environment conditions.

Parameters:
xEnvironmental conditions.
Returns:
The occurrence probability in the range [0,1].

Implements AlgorithmImpl.

Definition at line 196 of file envelope_score.cpp.

References _maximum, _minimum, and Sample::size().

Here is the call graph for this function:

int EnvelopeScore::initialize ( ) [virtual]

Initiate a new training.

Implements AlgorithmImpl.

Definition at line 150 of file envelope_score.cpp.

References _done, AlgorithmImpl::_samp, computeStats(), Log::error(), Log::info(), and Log::instance().

Here is the call graph for this function:

int EnvelopeScore::iterate ( ) [virtual]

One step further on the training. Return 0 if something wrong happened.

Reimplemented from AlgorithmImpl.

Definition at line 177 of file envelope_score.cpp.

void EnvelopeScore::logEnvelope ( ) [private]

Log the bioclimatic envelopes information.

Definition at line 297 of file envelope_score.cpp.

References _maximum, _minimum, Log::info(), Log::instance(), and Sample::size().

Here is the call graph for this function:

Member Data Documentation

bool EnvelopeScore::_done [private]

Definition at line 73 of file envelope_score.hh.

Referenced by _getConfiguration(), _setConfiguration(), done(), and initialize().

Sample EnvelopeScore::_maximum [private]

> Mininum value for each variable.

Definition at line 76 of file envelope_score.hh.

Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), and logEnvelope().

Sample EnvelopeScore::_minimum [private]

> is true if the algorithm is finished.

Definition at line 75 of file envelope_score.hh.

Referenced by _getConfiguration(), _setConfiguration(), computeStats(), getValue(), and logEnvelope().

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