state_vector.h

Go to the documentation of this file.

#ifndef STATE_VECTOR_H
#define STATE_VECTOR_H
#include "printable.h"
#include "observer.h"
#include "array_ad.h"
#include "fp_exception.h"
#include <blitz/array.h>

namespace FullPhysics {

/****************************************************************/
class StateVector : public Printable<StateVector>, public Observable<StateVector> {
public:
  StateVector()
    : pstart(0)
  {
  }
  virtual ~StateVector() { }

  virtual void add_observer(Observer<StateVector>& Obs) 
  { add_observer_do(Obs, *this);}
  virtual void remove_observer(Observer<StateVector>& Obs) 
  { remove_observer_do(Obs, *this);}
  virtual void print(std::ostream& Os) const;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const blitz::Array<double, 1>& state() const { return x_.value(); }

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const ArrayAd<double, 1>& state_with_derivative() const { return x_;}

  blitz::Array<std::string, 1> state_vector_name() const;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  const blitz::Array<double, 2>& state_covariance() const {return cov_;}

  void update_state(const blitz::Array<double, 1>& X);
  void update_state(const blitz::Array<double, 1>& X, const blitz::Array<double, 2>& Cov);
  blitz::Array<bool, 1> used_flag() const;

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  int observer_claimed_size() const {return pstart;}

//-----------------------------------------------------------------------
//-----------------------------------------------------------------------

  void observer_claimed_size(int Pstart) { pstart = Pstart; }

private:
  ArrayAd<double, 1> x_;
  blitz::Array<double, 2> cov_;
  // Helper value that says what portion of state vector has been
  // claimed by observers. We don't do anything with this value in
  // this class, except make it available to StateVectorObservers when 
  // they are attached.
  int pstart;
};
}

#endif