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
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
|
#ifndef INCLUDED_NJN_DYNPROGPROB
#define INCLUDED_NJN_DYNPROGPROB
/* $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_dynprogprob.hpp
Author: John Spouge
Contents:
******************************************************************************/
#include "njn_dynprogprobproto.hpp"
#include <climits>
namespace Njn {
class DynProgProb : public DynProgProbProto {
// DynProgProb performs updates for probabilities in a dynamic programming computation.
// The object expands storage as necessary to hold all probabilities.
//
// 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 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_.
public:
static const size_t VALUE_BEGIN;
static const size_t ARRAY_CAPACITY;
inline DynProgProb ( // range for long int values = [valueLower_, valueUpper_)
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 assigns prob_ [0] = 1.0
// if (valueLower_ == 0 && valueUpper_ == 0) prob_ [-(ARRAY_CAPACITY / 2) + 1...ARRAY_CAPACITY / 2]
// otherwise
// prob_ [valueLower_...valueUpper_)
: d_step (0), d_arrayCapacity (0), d_valueBegin (0),
d_valueLower (0), d_valueUpper (0),
d_valueFct (0), d_dimInputProb (0), d_inputProb_p (0)
{
d_array_p [0] = d_array_p [1] = 0;
setValueFct (valueFct_);
setInput (dimInputProb_, inputProb_);
clear (valueLower_, valueUpper_, prob_);
}
inline DynProgProb (const DynProgProb &dynProgProb_)
: d_step (0), d_arrayCapacity (0), d_valueBegin (0),
d_valueLower (0), d_valueUpper (0),
d_valueFct (0), d_dimInputProb (0), d_inputProb_p (0)
{
copy (dynProgProb_);
}
virtual inline ~DynProgProb ()
{
free2 ();
freeInput ();
}
virtual inline operator bool () // ? is the object ready for computation ?
const {
return getArrayCapacity () != 0 &&
d_valueFct && d_dimInputProb != 0 && d_inputProb_p;
}
virtual inline DynProgProb &operator= (const DynProgProb &dynProgProb_)
{
if (this != &dynProgProb_) copy (dynProgProb_);
return *this;
}
virtual inline void copy (const DynProgProb &dynProgProb_)
{
copy (dynProgProb_.getStep (),
dynProgProb_.getArray (), dynProgProb_.getArrayCapacity (),
dynProgProb_.getValueBegin (), dynProgProb_.getValueLower (), dynProgProb_.getValueUpper (),
dynProgProb_.getValueFct (), dynProgProb_.getDimInputProb (), dynProgProb_.getInputProb ());
}
virtual void copy (
size_t step_, // current index : starts at 0
const double *const *array_, // two corresponding arrays of probabilities
size_t arrayCapacity_, // present capacity of the array
long int valueBegin_ = 0, // lower limit for long int values in the array (an offset)
long int valueLower_ = 0, // present lower long int value in the array
long int valueUpper_ = 0, // one beyond present upper long int value in the array
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]
virtual 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 assigns prob_ [0] = 1.0
// assumes prob_ [valueLower_, valueUpper_)
virtual inline void clear () {clear (0);}
virtual inline void setValueFct (ValueFct *valueFct_) // function for updating dynamic programming values
{
d_valueFct = valueFct_;
}
virtual void setInput (
size_t dimInputProb_,
const double *inputProb_); // array of input states : d_inputProb_p [0...dimInputProb - 1]
virtual void update (); // updates dynamic prog probs
// assert (getValueFct ());
// assert (getDimInputProb ());
// assert (getInputProb ());
virtual inline double getProb (long int value_) const // probability value
{
assert (getArray ());
assert (getArray () [getStep () % 2]);
if (value_ < getValueBegin ()) return 0.0;
if (getValueEnd () <= value_) return 0.0;
return getArray () [getStep () % 2][getArrayPos (value_)];
}
virtual inline size_t getStep () const {return d_step;} // current index : starts at 0
virtual inline const double *const *getArray () const {return d_array_p;} // two corresponding arrays of probabilities d_array_p [0,1][0...d_arrayCapacity - 1]
virtual inline size_t getArrayCapacity () const {return d_arrayCapacity;} // # (different values)
virtual inline long int getValueBegin () const {return d_valueBegin;} // lower limit for long int values in the array (an offset)
virtual inline long int getValueLower () const {return d_valueLower;} // present lower long int value in the array
virtual inline long int getValueUpper () const {return d_valueUpper;} // one beyond present upper long int value in the array
virtual inline ValueFct *getValueFct () const {return d_valueFct;} // function for updating dynamic programming values
virtual inline size_t getDimInputProb () const {return d_dimInputProb;}
virtual inline const double *getInputProb () const {return d_inputProb_p;} // array of input states : d_inputProb_p [0...dimInputProb - 1]
private:
size_t d_step; // current index for time-step : starts at 0
double *d_array_p [2]; // two corresponding arrays of probabilities d_array_p [0,1][0...d_arrayCapacity - 1]
// d_array_p [0...1][0...d_valueBound [1] - d_valueBound [0] - 1]
size_t d_arrayCapacity; // present capacity of the array
long int d_valueBegin; // lower limit for long int values in the array (an offset)
long int d_valueLower; // present lower long int value in the array
long int d_valueUpper; // one beyond present upper long int value in the array
// parameters for update (which might be constant throughout the calculation)
ValueFct *d_valueFct; // function for updating dynamic programming values
size_t d_dimInputProb;
double *d_inputProb_p; // array of input states : d_inputProb_p [0...dimInputProb - 1]
virtual void initInput (size_t dimInputProb_); // array of input states : d_inputProb_p [0...dimInputProb - 1]
virtual void freeInput ();
virtual inline long int getValue (size_t arrayPos_) const { // value corresponding to array position
return static_cast <long int> (arrayPos_) + getValueBegin ();
}
virtual void init (size_t arrayCapacity_); // range for d_array_p [0,1][0...arrayCapacity_ - 1]
virtual void free2 ();
protected:
virtual void clear (
long int valueBegin_, // lower limit for long int values in the array (an offset)
size_t arrayCapacity_); // new array capacity
virtual inline long int getArrayPos (long int value_) const // offset for array position containing value_
{ // no range-checking
return value_ - getValueBegin ();
}
virtual inline long int getValueEnd () const // one beyond largest possible long int value in present range
{
return getValue (getArrayCapacity ());
}
void reserve (size_t arrayCapacity_); // new array capacity
// increases capacity of and copies d_array_p, while updating other variables
virtual void setValueBegin (long int valueBegin_); // lowest possible long int value in the array
virtual inline size_t &lgetStep () {return d_step;} // current index : starts at 0
virtual inline double **lgetArray () {return d_array_p;} // two corresponding arrays of probabilities d_array_p [0,1][0...d_arrayCapacity - 1]
virtual inline size_t &lgetArrayCapacity () {return d_arrayCapacity;} // # (different values)
virtual inline long int &lgetValueBegin () {return d_valueBegin;} // lower limit for long int values in the array (an offset)
virtual inline long int &lgetValueLower () {return d_valueLower;} // present lower long int value in the array
virtual inline long int &lgetValueUpper () {return d_valueUpper;} // one beyond present upper long int value in the array
};
}
#endif
|
