// file: $isip/class/algo/Prediction/Prediction.h
// version: $Id: Prediction.h 10636 2007-01-26 22:18:09Z tm334 $
//

// make sure definitions are only made once
//
#ifndef ISIP_PREDICTION
#define ISIP_PREDICTION

#ifndef ISIP_ALGORITHM_BASE
#include <AlgorithmBase.h>
#endif

#ifndef ISIP_CORRELATION
#include <Correlation.h>
#endif

#ifndef ISIP_COVARIANCE
#include <Covariance.h>
#endif

#ifndef ISIP_REFLECTION
#include <Reflection.h>
#endif

// Prediction: a class that computes the linear prediction
// coefficients from autocorrelation, covariance matrix, signal,
// reflection coefficients or log-area-ratios. four algorithms have
// been implemented: AUTOCORRELATION, COVARIANCE, LATTICE and
// REFLECTION.
//
class Prediction : public AlgorithmBase {

  //---------------------------------------------------------------------------
  //
  // public constants
  //
  //---------------------------------------------------------------------------
public:
  
  // define the class name
  //
  static const String CLASS_NAME;
  
  //----------------------------------------
  //
  // other important constants
  //
  //----------------------------------------
    
  // define the algorithm choices
  //
  enum ALGORITHM { AUTOCORRELATION = 0, COVARIANCE, LATTICE, REFLECTION,
		   LOG_AREA_RATIO, DEF_ALGORITHM = AUTOCORRELATION };
  
  // define the implementation choices
  //
  enum IMPLEMENTATION { DURBIN = 0, LEROUX_GUEGUEN, CHOLESKY, BURG,
			STEP_DOWN, KELLY_LOCHBAUM,
			DEF_IMPLEMENTATION = DURBIN };

  // define the static NameMap objects
  //
  static const NameMap ALGO_MAP;
  static const NameMap IMPL_MAP;

  //----------------------------------------
  //
  // i/o related constants
  //
  //----------------------------------------  
  
  static const String DEF_PARAM;
  static const String PARAM_ALGORITHM;
  static const String PARAM_IMPLEMENTATION;
  static const String PARAM_ORDER;
  static const String PARAM_DYN_RANGE;

  //----------------------------------------
  //
  // default values and arguments
  //
  //----------------------------------------  
  
  // define the default value(s) of the class data
  //
  static const long DEF_ORDER = -1;
  static const float DEF_DYN_RANGE = -100.0;

  // define default argument(s)
  //
  static const AlgorithmData::COEF_TYPE DEF_COEF_TYPE =
  AlgorithmData::CORRELATION;
  
  //----------------------------------------
  //
  // error codes
  //
  //----------------------------------------  
  
  static const long ERR = 71100;
  static const long ERR_DYNRANGE = 71101;
  static const long ERR_BETA = 71102;
  static const long ERR_ENERGY = 71103;
  static const long ERR_PREDERR = 71104;
  
  //---------------------------------------------------------------------------
  //
  // protected data
  //
  //---------------------------------------------------------------------------
protected:
  
  // algorithm name
  //
  ALGORITHM algorithm_d;

  // implementation name
  //
  IMPLEMENTATION implementation_d;

  // parameters related to the algorithm specification
  //
  Long order_d;
  Float dyn_range_d;
  
  // a static memory manager
  //
  static MemoryManager mgr_d;
  
  //---------------------------------------------------------------------------
  //
  // required public methods
  //
  //---------------------------------------------------------------------------
public:
    
  // method: name
  //
  static const String& name() {
    return CLASS_NAME;
  }

  // other static methods
  //
  static boolean diagnose(Integral::DEBUG debug_level);
  
  // debug methods:
  //  setDebug is inherited from the base class
  //
  boolean debug(const unichar* msg) const;

  // method: destructor
  //
  ~Prediction() {}

  // constructor
  //
  Prediction(ALGORITHM algorithm = DEF_ALGORITHM,
	     IMPLEMENTATION implementation = DEF_IMPLEMENTATION,
	     long order = DEF_ORDER,
	     float dyn_range = DEF_DYN_RANGE) {
    algorithm_d = algorithm;
    implementation_d = implementation;
    order_d = order;
    dyn_range_d = dyn_range;
    is_valid_d = false;
  }

  // method: copy constructor
  //
  Prediction(const Prediction& arg) {
    assign(arg);
  }
  
  // assign methods
  //
  boolean assign(const Prediction& arg);

  // method: operator=
  //
  Prediction& operator= (const Prediction& arg) {
    assign(arg);
    return *this;
  }
  
  // i/o methods
  //
  long sofSize() const;
  
  boolean read(Sof& sof, long tag, const String& name = CLASS_NAME);
  boolean write(Sof& sof, long tag, const String& name = CLASS_NAME) const;

  boolean readData(Sof& sof, const String& pname = DEF_PARAM,
                   long size = SofParser::FULL_OBJECT,
                   boolean param = true,
                   boolean nested = false);
  boolean writeData(Sof& sof, const String& name = DEF_PARAM) const;

  // equality methods
  //
  boolean eq(const Prediction& arg) const;

  // method: new
  //
  static void* operator new(size_t size) {
    return mgr_d.get();
  }

  // method: new[]
  //
  static void* operator new[](size_t size) {
    return mgr_d.getBlock(size);
  }

  // method: delete
  //
  static void operator delete(void* ptr) {
    mgr_d.release(ptr);
  }

  // method: delete[]
  //
  static void operator delete[](void* ptr) {
    mgr_d.releaseBlock(ptr);
  }
  
  // method: setGrowSize
  // 
  static boolean setGrowSize(long grow_size) {
    return mgr_d.setGrow(grow_size);
  }

  // other memory-management methods
  //
  boolean clear(Integral::CMODE ctype = Integral::DEF_CMODE);

  //---------------------------------------------------------------------------
  //
  // class-specific public methods:
  //  set methods
  //
  //---------------------------------------------------------------------------
 
  // method: setAlgorithm
  //
  boolean setAlgorithm(ALGORITHM algorithm) {
    algorithm_d = algorithm;
    is_valid_d = false;
    return true;  
  }
  
  // method: setImplementation
  //
  boolean setImplementation(IMPLEMENTATION implementation) {
    implementation_d = implementation;
    is_valid_d = false;
    return true;  
  }
  
  // method: setOrder
  //
  boolean setOrder(long order) {
    order_d = order;
    is_valid_d = false;
    return true;  
  }
  
  // method: setDynRange
  //
  boolean setDynRange(float dyn_range) {
    dyn_range_d = dyn_range;
    is_valid_d = false;
    return true;  
  }

  // method: set
  //
  boolean set(ALGORITHM algo = DEF_ALGORITHM,
	      IMPLEMENTATION impl = DEF_IMPLEMENTATION,
	      long order = DEF_ORDER, float dyn_range = DEF_DYN_RANGE) {
    algorithm_d = algo;
    implementation_d = impl;
    order_d = order;
    dyn_range_d = dyn_range;
    is_valid_d = false;
    return true;  
  }

  //---------------------------------------------------------------------------
  //
  // class-specific public methods:
  //  get methods
  //
  //---------------------------------------------------------------------------

  // method: getAlgorithm
  //
  ALGORITHM getAlgorithm() const {  
    return algorithm_d;
  }

  // method: getImplementation
  //
   IMPLEMENTATION getImplementation() const {  
    return implementation_d;
  }

  // method: getOrder
  //
  long getOrder() const {
    return order_d;
  }

  // method: getDynRange
  //
  float getDynRange() const {
    return dyn_range_d;
  }
  
  // method: get
  //
  boolean get(ALGORITHM& algorithm, IMPLEMENTATION& implementation,
	      long& order, float& dyn_range) const {
    algorithm = algorithm_d;
    implementation = implementation_d;
    order = order_d;
    dyn_range = dyn_range_d;
    return true;  
  }

  //---------------------------------------------------------------------------
  //
  // class-specific public methods:
  //  computational methods
  //
  //---------------------------------------------------------------------------

  boolean compute(VectorFloat& output, const VectorFloat& input,
		  AlgorithmData::COEF_TYPE input_coef_type = DEF_COEF_TYPE,
		  long index = DEF_CHANNEL_INDEX);
  boolean compute(VectorFloat& output, const MatrixFloat& input,
		  AlgorithmData::COEF_TYPE input_coef_type = DEF_COEF_TYPE,
		  long index = DEF_CHANNEL_INDEX);
  boolean compute(VectorFloat& output, float& err_energy,
		  const VectorFloat& input,
		  AlgorithmData::COEF_TYPE input_coef_type = DEF_COEF_TYPE,
		  long index = DEF_CHANNEL_INDEX);
  boolean compute(VectorFloat& output, float& err_energy,
		  const MatrixFloat& input,
		  AlgorithmData::COEF_TYPE input_coef_type = DEF_COEF_TYPE,
		  long index = DEF_CHANNEL_INDEX);

  //---------------------------------------------------------------------------
  //
  // class-specific public methods:
  //  public methods required by the AlgorithmBase interface contract
  //
  //---------------------------------------------------------------------------

  // assign method
  //
  boolean assign(const AlgorithmBase& arg);

  // equality method
  //  
  boolean eq(const AlgorithmBase& arg) const;
  
  // method: className
  //
  const String& className() const {
    return CLASS_NAME;
  }
  
  // computational methods
  //
  boolean apply(Vector<AlgorithmData>& output,
		const Vector< CircularBuffer<AlgorithmData> >& input);
  
  // method to set the parser 
  //
  boolean setParser(SofParser* parser);

  //---------------------------------------------------------------------------
  //
  // private methods
  //
  //---------------------------------------------------------------------------
private:

  // algorithm-specific i/o methods
  //
  boolean readDataCommon(Sof& sof, const String& pname,
                         long size = SofParser::FULL_OBJECT,
                         boolean param = true, boolean nested = false);
  boolean writeDataCommon(Sof& sof, const String& pname) const;

  // algorithm and implementation specific computational methods
  //
  boolean computeAutoDurbin(VectorFloat& output, float& err_energy,
			    const VectorFloat& input);
  boolean computeCovarCholesky(VectorFloat& output, float& err_energy,
			       const MatrixFloat& input);
  boolean computeLatticeBurg(VectorFloat& output, float& err_energy,
			     const VectorFloat& input);
  boolean computeReflectionStepDown(VectorFloat& output,
				    const VectorFloat& input);
  boolean computeLogAreaKellyLochbaum(VectorFloat& output,
				      const VectorFloat& input);  
};

// end of include file
// 
#endif
