1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165
|
#ifndef INCLUDED_NJN_DYNPROGPROBLIM
#define INCLUDED_NJN_DYNPROGPROBLIM
/* $Id: $
* ===========================================================================
*
* PUBLIC DOMAIN NOTICE
* National Center for Biotechnology Information
*
* This software/database is a "United States Government Work" under the
* terms of the United States Copyright Act. It was written as part of
* the author's offical duties as a United States Government employee and
* thus cannot be copyrighted. This software/database is freely available
* to the public for use. The National Library of Medicine and the U.S.
* Government have not placed any restriction on its use or reproduction.
*
* Although all reasonable efforts have been taken to ensure the accuracy
* and reliability of the software and data, the NLM and the U.S.
* Government do not and cannot warrant the performance or results that
* may be obtained by using this software or data. The NLM and the U.S.
* Government disclaim all warranties, express or implied, including
* warranties of performance, merchantability or fitness for any particular
* purpose.
*
* Please cite the author in any work or product based on this material.
*
* ===========================================================================*/
/*****************************************************************************
File name: njn_dynprogproblim.hpp
Author: John Spouge
Contents:
******************************************************************************/
#include "njn_dynprogprob.hpp"
namespace Njn {
class DynProgProbLim : public DynProgProb {
// DynProgProbLim performs updates for probabilities in a dynamic programming computation.
// The object limits storage to [valueLower_, valueUpper_).
// Probability outside the limits can be obtained from getProbLost ().
//
// The object behaves as follows:
//
// Default:
// (1) The initial state of the dynamic programming computation is 0 with probability 1.0.
//
// Behavior:
// (2) If input_ is the computation's input, it replaces oldValue_ with ValueFct (oldValue_, input_)
// (3) The dynamic programming function can be reset with setValueFct (...).
// (4) The probability for the input states can be reset with setInput (...).
// (5) The probability of input_ = [0, dimInputProb_) is inputProb_ [input_].
// (6) getProb (long int i_) returns the probability corresponding to the long int value i_.
// (7) The values are limited to [d_valueBegin, d_valueEnd), which are initialized with [valueLower_, valueUpper_).
// (8) getLostProb () returns the lost probability.
public:
inline DynProgProbLim (
ValueFct *valueFct_ = 0, // function for updating dynamic programming values
size_t dimInputProb_ = 0,
const double *inputProb_ = 0, // array of input states : d_inputProb_p [0...dimInputProb - 1]
// The following behave like arguments to clear ().
long int valueLower_ = 0, // lower long int value corresponding to the "probability" array
long int valueUpper_ = 0, // one beyond present upper long int value corresponding to the "probability" array
const double *prob_ = 0) // "probabilities" prob [valueLower_, valueUpper_) corresponding to the long ints
// default prob_ == 0 : equivalent to
// prob_ [0] = 1.0
// assert (valueLower_ <= 0);
// assert (0 < valueUpper_);
: DynProgProb (valueFct_, dimInputProb_, inputProb_, valueLower_, valueUpper_, prob_),
d_probLost (0.0)
{}
inline DynProgProbLim (const DynProgProbLim &dynProgProbLim_)
: DynProgProb (dynProgProbLim_),
d_probLost (dynProgProbLim_.getProbLost ())
{}
virtual inline ~DynProgProbLim () {}
virtual inline DynProgProbLim &operator= (const DynProgProbLim &dynProgProbLim_)
{
if (this != &dynProgProbLim_) copy (dynProgProbLim_);
return *this;
}
virtual inline void copy (const DynProgProbLim &dynProgProbLim_)
{
copy (dynProgProbLim_, dynProgProbLim_.getProbLost ());
}
virtual inline void copy (
const DynProgProb &dynProgProb_, // base object
double probLost_) // lower limit for long int values in the array (an offset)
{
DynProgProb::copy (dynProgProb_);
d_probLost = probLost_;
}
virtual void setLimits (
long int valueBegin_ = 0, // Range for values is [valueBegin_, valueEnd_).
long int valueEnd_ = 0); // Range for values is [valueBegin_, valueEnd_).
// resets the limits, transferring any probability outside the new limit to d_probLost
virtual void update (); // updates dynamic prog probs
// assert (getValueFct ());
// assert (getDimInputProb ());
// assert (getInputProb ());
virtual inline void clear ( // restarts the computation
long int valueLower_, // lower long int value corresponding to the "probability" array
long int valueUpper_ = 0, // one beyond present upper long int value corresponding to the "probability" array
const double *prob_ = 0) // "probabilities" prob_ [valueLower_, valueUpper_) corresponding to the long ints
// default prob_ = 0 corresponds to probability 1.0 at value = 0
// assumes prob_ [valueLower_, valueUpper_)
{
DynProgProb::clear (valueLower_, valueUpper_, prob_);
d_probLost = 0.0;
}
virtual inline void clear () {clear (0);}
using DynProgProb::operator bool; // ? is the object ready for computation ?
using DynProgProb::setValueFct;
using DynProgProb::setInput;
using DynProgProb::getProb; // probability value
using DynProgProb::getStep; // current index : starts at 0
using DynProgProb::getArray; // two corresponding arrays of probabilities d_array_p [0,1][0...d_arrayCapacity - 1]
using DynProgProb::getArrayCapacity; // # (different values)
using DynProgProb::getValueBegin; // lower limit for long int values in the array (an offset)
using DynProgProb::getValueLower; // present lower long int value in the array
using DynProgProb::getValueUpper; // one beyond present upper long int value in the array
using DynProgProb::getValueFct; // function for updating dynamic programming values
using DynProgProb::getDimInputProb;
using DynProgProb::getInputProb; // array of input states : d_inputProb_p [0...dimInputProb - 1]
virtual inline double getProbLost () const {return d_probLost;} // probability outside limits
private:
double d_probLost; // probability outside limits
virtual void reserve (size_t arrayCapacity_); // new array capacity
// reduces capacity of and copies d_array_p from its begin
virtual void setValueBegin (long int valueBegin_); // lowest possible long int value in the array
using DynProgProb::getValueEnd; // one beyond largest possible long int value in present range
using DynProgProb::getArrayPos; // offset for array position containing value_
};
}
#endif
|