nCenterFocus::BaseRankStatistic Class Reference
[Rank Statistics]

Designed to hold statistics of a single centerfocus experiment, namely distribution of jacobian rank for different numbers of vanished focal values. More...

#include <RangStatistik.h>

Collaboration diagram for nCenterFocus::BaseRankStatistic:
Collaboration graph
[legend]

List of all members.

Public Member Functions

void clear ()
constructors and destructor

 BaseRankStatistic (std::string name, int _requestedMinSuccessiveVanishedFocalValues, int _maxFocalValuesToCompute, int _maxRank)
 see details: RankStatistic()
 BaseRankStatistic (const BaseRankStatistic &)
BaseRankStatisticoperator= (const BaseRankStatistic &)
virtual ~BaseRankStatistic ()
addStatistic

void addRankStatistic (int successiveVanishedFocalValues, int jacobianRank)
access object properties and statistic

int getSmallesLoggedNumOfVanishedFocalValues () const
 return smallest focal value index for which addRankStatistic() logs rank statistic
int getHighestLoggedNumOfVanishedFocalValues () const
 return greatest focal value index for which addRankStatistic() logs rank statistic
int getHighestLoggedJacobianRank () const
 return major allowed jacobian rank parameter value passed to addRankStatistic()
long64 getOccurenceWithGivenNumOfVanishedFocalValues (int successiveVanishedNum) const
 get number of trials where vanished focal Values is equal(!) to parameter 'successiveVanishedNum'
int getNumOfOccuredJacobianRank (int successiveVanishedNum, int jacobianRank) const
io

void print (std::ostream &f) const
 prints rank statistic in Macaulay style. - ( name +' = ' + value + ' ; ' ) Value Format: ..{ number of successive vanished focal values, {occurrence count, portion with jacobian rank 0, portion with jacobian rank 1, ..., portion with jacobain rank = maxRank} },
{ next number of successive vanished focal values, { ...
...
std::string getValueAsString () const

Static Public Attributes

static const std::string fullRankStatisticString
static const std::string subRankStatisticString

Private Member Functions

 BaseRankStatistic ()
void init ()
 create and initialize jacobianRankCounters_m; initialize exactVanishedFocalValuesStatistic_m.
acess to rank statistic data

long64 getJacobianRankCounter (int index) const
 get jacobian rank counter by index
long64getJacobianRankCounterRef (int index)
 get jacobian rank counter reference by index
int getRankStatisticIndex (int successiveVanishedNum, int jacobianRank) const
 get exactVanishedFocalValuesStatistic_m- index for given successiveVanishedNum and jacobianRank.
safety

void testbounds (int maxbound) const

Private Attributes

data

std::string name_m
int maxRank
 max expected jacobian rank to log
int maxFocalValuesToCompute
 max expected number of successive vanished focal values to log
int minSuccessiveZeroFocalValues
 smallest expected number of successive vanished focal values to log
long64jacobianRankCounters_m
 statistic data; see details for format description: jacobianRankCounters_m
long64exactVanishedFocalValuesStatistic_m
 exactVanishedFocalValuesStatistic_m[i] contains trial count where exactly first i focal values vanished if i>=minSuccessiveZeroFocalValues
int arrayLength
 size of jacobianRankCounters_m

Detailed Description

Todo:
eventuell eine Unterklasse bilden, welche für eine feste Anzahl verschwundener Strudelgrößen die Ränge der Jacobi-Matrizen zählt.
Todo:
bessere Parameternamen im Konstruktor und diese dokumentieren, sowohl in BaseRankStatistic als auch in RankAndLiftStatistic.

Definition at line 33 of file RangStatistik.h.


Constructor & Destructor Documentation

nCenterFocus::BaseRankStatistic::BaseRankStatistic ( std::string  name,
int  _requestedMinSuccessiveVanishedFocalValues,
int  _maxFocalValuesToCompute,
int  _maxRank 
)

Holds statistics for at least _minSuccessiveZeroFocalValues vanished focal values
number of vanished focal values cannot exteed _maxFocalValues,
maximal expected and allowed jacobian rank is _maxRank

/

Precondition:
name is macaulay-compilant variable name (without whitespaces, '_', and '--',; first character is a ASCII- literal 'aA..zZ'
_minSuccessiveZeroFocalValues, _maxFocalValues und _maxRank >=0
Todo:
note the max possible value for jacobian rank?
Parameters:
_requestedMinSuccessiveVanishedFocalValues expected minimal #(vanished focal values) - parameter passed to addRankStatistic()
_maxFocalValuesToCompute expected maximal (number of vanished focal values) - parameter passed to addRankStatistic()
_maxRank expected maximal rank parameter passed to addRankStatistic()

Definition at line 58 of file RangStatistik.cpp.

References init().

Here is the call graph for this function:

nCenterFocus::BaseRankStatistic::BaseRankStatistic ( const BaseRankStatistic ref  ) 

Definition at line 75 of file RangStatistik.cpp.

References arrayLength, exactVanishedFocalValuesStatistic_m, init(), jacobianRankCounters_m, and maxFocalValuesToCompute.

Here is the call graph for this function:

nCenterFocus::BaseRankStatistic::~BaseRankStatistic (  )  [virtual]

Definition at line 168 of file RangStatistik.cpp.

References jacobianRankCounters_m.

nCenterFocus::BaseRankStatistic::BaseRankStatistic (  )  [private]

Member Function Documentation

void nCenterFocus::BaseRankStatistic::addRankStatistic ( int  successiveVanishedFocalValues,
int  jacobianRank 
)

count occurence of number of vanishedFocalvalues

count rank:

Definition at line 249 of file RangStatistik.cpp.

References exactVanishedFocalValuesStatistic_m, getJacobianRankCounterRef(), getRankStatisticIndex(), maxFocalValuesToCompute, and minSuccessiveZeroFocalValues.

Here is the call graph for this function:

void nCenterFocus::BaseRankStatistic::clear (  ) 
int nCenterFocus::BaseRankStatistic::getHighestLoggedJacobianRank (  )  const

Definition at line 187 of file RangStatistik.cpp.

References maxRank.

int nCenterFocus::BaseRankStatistic::getHighestLoggedNumOfVanishedFocalValues (  )  const

Definition at line 181 of file RangStatistik.cpp.

References maxFocalValuesToCompute.

Referenced by getValueAsString().

long64 nCenterFocus::BaseRankStatistic::getJacobianRankCounter ( int  index  )  const [private]

Definition at line 192 of file RangStatistik.cpp.

References jacobianRankCounters_m, and testbounds().

Referenced by getNumOfOccuredJacobianRank().

Here is the call graph for this function:

long64 & nCenterFocus::BaseRankStatistic::getJacobianRankCounterRef ( int  index  )  [private]

Definition at line 201 of file RangStatistik.cpp.

References jacobianRankCounters_m, and testbounds().

Referenced by addRankStatistic().

Here is the call graph for this function:

int nCenterFocus::BaseRankStatistic::getNumOfOccuredJacobianRank ( int  successiveVanishedNum,
int  jacobianRank 
) const

Definition at line 243 of file RangStatistik.cpp.

References getJacobianRankCounter(), and getRankStatisticIndex().

Referenced by getValueAsString().

Here is the call graph for this function:

long64 nCenterFocus::BaseRankStatistic::getOccurenceWithGivenNumOfVanishedFocalValues ( int  successiveVanishedNum  )  const
int nCenterFocus::BaseRankStatistic::getRankStatisticIndex ( int  successiveVanishedNum,
int  jacobianRank 
) const [private]
int nCenterFocus::BaseRankStatistic::getSmallesLoggedNumOfVanishedFocalValues (  )  const

Definition at line 174 of file RangStatistik.cpp.

References minSuccessiveZeroFocalValues.

Referenced by getValueAsString().

std::string nCenterFocus::BaseRankStatistic::getValueAsString (  )  const
void nCenterFocus::BaseRankStatistic::init (  )  [private]

Definition at line 137 of file RangStatistik.cpp.

References arrayLength, clear(), jacobianRankCounters_m, maxFocalValuesToCompute, maxRank, and minSuccessiveZeroFocalValues.

Referenced by BaseRankStatistic(), and operator=().

Here is the call graph for this function:

BaseRankStatistic & nCenterFocus::BaseRankStatistic::operator= ( const BaseRankStatistic ref  ) 
Todo:
: operator sicher implementieren..

Definition at line 101 of file RangStatistik.cpp.

References arrayLength, exactVanishedFocalValuesStatistic_m, init(), jacobianRankCounters_m, maxFocalValuesToCompute, maxRank, minSuccessiveZeroFocalValues, and name_m.

Here is the call graph for this function:

void nCenterFocus::BaseRankStatistic::print ( std::ostream &  os  )  const

Definition at line 311 of file RangStatistik.cpp.

References nCenterFocus::getMacaulayCompilantObjectName(), getValueAsString(), and name_m.

Here is the call graph for this function:

void nCenterFocus::BaseRankStatistic::testbounds ( int  maxbound  )  const [inline, private]

Definition at line 132 of file RangStatistik.cpp.

References arrayLength.

Referenced by getJacobianRankCounter(), and getJacobianRankCounterRef().


Member Data Documentation

Definition at line 136 of file RangStatistik.h.

Referenced by BaseRankStatistic(), clear(), init(), operator=(), and testbounds().

Definition at line 38 of file RangStatistik.h.

format: two dimensional array (row index+minSuccessiveZeroFocalValues) represents SuccessiveVanishedFocalValues
first column stores the occurance for given number of VanishedFocalValues(see above),
next column store the portion with jacobian rank 0 , the following column the portion with jacobian rank 1 and so on. jacobian rank statistic data. Structure: two-dimensional-array [ maxFocalValuesToCompute-minSuccessiveZeroFocalValues+1 ] x [maxRank +1]

Definition at line 128 of file RangStatistik.h.

Referenced by BaseRankStatistic(), clear(), getJacobianRankCounter(), getJacobianRankCounterRef(), init(), operator=(), and ~BaseRankStatistic().

Definition at line 114 of file RangStatistik.h.

Referenced by operator=(), and print().

Definition at line 39 of file RangStatistik.h.


The documentation for this class was generated from the following files:
Generated on Tue Nov 23 13:10:53 2010 for centerfocus by  doxygen 1.6.3