https://github.com/ElsevierSoftwareX/SOFTX_2019_219
Tip revision: c6d23f52bf7d7de2698a41518f6c2638decc9d6b authored by Konrad Werys on 26 October 2018, 15:54:52 UTC
minor changes
minor changes
Tip revision: c6d23f5
OxStartPointCalculator.h
/*!
* \file OxStartPointCalculator.h
* \author Konrad Werys
* \date 2018/07/29
*/
#ifndef Tomato_OXSTARTPOINTCALCULATOR_H
#define Tomato_OXSTARTPOINTCALCULATOR_H
#include "KWUtil.h"
namespace Ox {
/**
* \class StartPointCalculator
* \brief
* \details
* @tparam MeasureType
*/
template< typename MeasureType >
class StartPointCalculator{
public:
/**
* the most important function of this class
* @return success/failure
*/
virtual int calculateStartPoint() = 0;
// getters
MeasureType *getCalculatedStartPoint() const {
if (!_CalculatedStartPoint) throw std::runtime_error("_CalculatedStartPoint equals 0. Set _CalculatedStartPoint");
return _CalculatedStartPoint;
}
int getNDims() const { return _nDims; }
//setters
virtual void setInvTimes(const MeasureType *_InvTimes) { StartPointCalculator::_InvTimes = _InvTimes; }
virtual void setSigMag(const MeasureType *_SigMag) { StartPointCalculator::_SigMag = _SigMag; }
virtual void setSigns(const MeasureType *_Signs) { StartPointCalculator::_Signs = _Signs; }
virtual void setCalculatedStartPoint(MeasureType *_CalculatedStartPoint) { StartPointCalculator::_CalculatedStartPoint = _CalculatedStartPoint; }
virtual void setNSamples(int _nSamples) { StartPointCalculator::_nSamples = _nSamples; }
void disp(){
std::cout << "\nYou called disp() on a StartPointCalculator object " << this
<< " with nSamples: " << _nSamples
<< " nDims: " << _nDims;
KWUtil::printArray((bool)_InvTimes, _nSamples, _InvTimes, (char*)"\nInvTimes: ");
KWUtil::printArray((bool)_SigMag, _nSamples, _SigMag, (char*)"\nSigMag: ");
KWUtil::printArray((bool)_Signs, _nSamples, _Signs, (char*)"\nSigns: ");
KWUtil::printArray(_nDims, this->getCalculatedStartPoint(), (char*)"\nStart point: ");
}
/**
* \brief set all the pointers to zero
*/
void setAllPointersToNull(){
_CalculatedStartPoint = 0;
_InvTimes = 0;
_SigMag = 0;
_Signs = 0;
}
/**
* \brief constructor
*/
StartPointCalculator(){
setAllPointersToNull();
_nSamples = 0;
_nDims = 0;
}
/**
* \brief copy constructor
*/
StartPointCalculator(const StartPointCalculator &old){
setAllPointersToNull();
_nSamples = old._nSamples;
_nDims = old._nDims;
};
/**
* cloning
* @return
*/
virtual StartPointCalculator<MeasureType> *newByCloning() = 0;
/**
* \brief do not forget about the virtual destructor, see
* https://stackoverflow.com/questions/461203/when-to-use-virtual-destructors
*/
virtual ~StartPointCalculator(){};
protected:
MeasureType* _CalculatedStartPoint;
const MeasureType* _InvTimes;
const MeasureType* _SigMag;
const MeasureType* _Signs;
int _nSamples;
int _nDims; // special ShMOLLI parameter
};
} //namespace Ox
#endif //Tomato_OXSTARTPOINTCALCULATOR_H