linearshape.h

Go to the documentation of this file.

// include guard
#ifndef AFF_LINEARSHAPE_H_VERSION

#define AFF_LINEARSHAPE_H_VERSION \
  "AFF_LINEARSHAPE_H   V1.4"

namespace aff {

  namespace util {
    class SeriesStepper;
  } // namespace util

  class LinearShape 
  {
    public:
      static const Tdim Mmax_dimen=1;
      typedef aff::util::SeriesStepper Tstepper;
      LinearShape(): Mfirst(0), Mlast(0), Mbase(0) { }
      LinearShape(const Tsubscript& first,
                  const Tsubscript& last,
                  const Tsubscript& firstinrepr):
        Mfirst(first), Mlast(last), Mbase(first-firstinrepr) 
        { 
          AFF_assert((this->size()>=0),
              "ERROR (LinearShape): inconsistent constructor arguments");
        }
      const Tsubscript& first() const { return(Mfirst); }
      const Tsubscript& last() const { return(Mlast); }
      Tsubscript offset(const Tsubscript& i) const { return(i-Mbase); }
      const Tsize& base() const { return(Mbase); }
      Tsize size() const
      { return(static_cast<Tsize>(Mlast-Mfirst+1)); }
      Tsize memory_size() const { return(this->size()); }
      LinearShape& shrink(const Tdim& i, 
                      const Tsubscript& first, const Tsubscript& last)
      {
        AFF_assert((i==0),"ERROR (LinearShape::shrink): illegal dimension!");
        this->setindexrange(first, last);
        return(*this);
      }
      LinearShape& shrink(const Tdim& i, 
                      const Tsubscript& last)
      {
        AFF_assert((i==0),"ERROR (LinearShape::shrink): illegal dimension!");
        this->setlastindex(last);
        return(*this);
      }
      void setindexrange(const Tsubscript& first,
                         const Tsubscript last)
      {
          AFF_assert((last>=first),
              "ERROR (LinearShape::setindexrange): inconsistent arguments");
          setfirstindex(first);
          setlastindex(last);
      }
      void setfirstindex(const Tsubscript& first)
      {
          AFF_assert(((first>=Mfirst)&&(first<=Mlast)),
              "ERROR (LinearShape::setfirstindex): index value out of range");
          Mfirst=first;
      }
      void setlastindex(const Tsubscript& last)
      {
          AFF_assert(((last>=Mfirst)&&(last<=Mlast)),
              "ERROR (LinearShape::setlastindex): index value out of range");
          Mlast=last;
      }
      void shift(const Tsubscript& i)
      {
        Mfirst+=i;
        Mlast+=i;
        Mbase+=i;
      }
    private:
      Tsubscript Mfirst; 
      Tsubscript Mlast;  
      Tsize Mbase;       
  }; // LinearShape

}

#endif // AFF_LINEARSHAPE_H_VERSION (includeguard)

/* ----- END OF linearshape.h ----- */