STK_Inx.h

Go to the documentation of this file.

/*--------------------------------------------------------------------*/
/*     Copyright (C) 2004-2009  Serge Iovleff

    This program is free software; you can redistribute it and/or modify
    it under the terms of the GNU Lesser General Public License as
    published by the Free Software Foundation; either version 2 of the
    License, or (at your option) any later version.

    This program is distributed in the hope that it will be useful,
    but WITHOUT ANY WARRANTY; without even the implied warranty of
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
    GNU Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this program; if not, write to the
    Free Software Foundation, Inc.,
    59 Temple Place,
    Suite 330,
    Boston, MA 02111-1307
    USA

    Contact : Serge.Iovleff@stkpp.org
*/
/*--------------------------------------------------------------------*/
/* $Id$
 *
 * Project:  Base
 * Purpose:  Define the Inx class.
 * Author:   Serge Iovleff, serge.iovleff@stkpp.org
 *
 * $Log$
 * Revision 1.4  2009/09/14 13:33:38  siovleff
 * Refactoring Contant strings
 *
 **/
/*--------------------------------------------------------------------*/
#ifndef STK_INX_H
#define STK_INX_H

#include "STK_Integer.h"
#include "STK_Stream.h"

namespace STK
{
/*--------------------------------------------------------------------*/
class Inx
{
  private:
    Integer first_;    
    Integer last_;     
    Integer size_;     

  public:
    /*----------------------------------------------------------------*/
    /* Ctors.                                                         */
    Inx(const Integer& last =0);

    Inx(const Integer& first, const Integer& last);

    Inx(const Inx &I);

     ~Inx();

    /*----------------------------------------------------------------*/
    /* Accessors.                                                     */
    inline Integer first()  const { return first_;};

    inline Integer last()    const { return last_;};

    inline Integer size()   const { return size_;};

    inline bool    empty() const { return size_<=0;};

    inline Integer begin()  const { return first_;};

    inline Integer end()    const { return last_+1;};

    inline bool    isIncludeIn(const Inx &I) const
    { return ((first_>= I.first_)&&(last_<=I.last_));}

    inline bool    isContaining(const Inx &I) const
    { return ((first_<= I.first_)&&(last_>=I.last_));}

    inline bool    isContaining(const Integer &i) const
    { return ((first_<=i)&&(last_>=i));}

    inline bool operator==(const Inx &I) const
    { return ((first_ == I.first()) && (last_ == I.last()));}

    inline bool operator!=(const Inx &I) const
    { return ((first_ != I.first()) || (last_ != I.last()));}

    /*----------------------------------------------------------------*/
    /* Modification Methods.                                          */
    Inx& set(const Integer& first =1, const Integer& last =0);
    Inx& shift(const Integer& first =1);
    Inx& inc(const Integer &inc =1);
    Inx& incFirst(const Integer &inc =1);
    Inx& incLast(const Integer &inc =1);
    Inx& dec(const Integer &dec =1);
    Inx& decFirst(const Integer &dec =1);
    Inx& decLast(const Integer &dec =1);

    /*----------------------------------------------------------------*/
    /* Modification Methods.                                          */
    Inx& sup(const Inx &I);

    Inx& inf(const Inx &I);

    static Inx sup(const Inx& I, const Inx& J);

    static Inx inf(const Inx& I, const Inx& J);

    /*----------------------------------------------------------------*/
    /* Operators.                                                     */
    // The operator = have not been defined, default = is Ok
    Inx& operator+=(const Integer &inc);
    Inx& operator-=(const Integer &dec);
    Inx operator+(const Integer &inc) const;
    Inx operator-(const Integer &dec) const;
    friend ostream& operator<< (ostream& s, const Inx& I);
};
/* End of the class STK::Inx.                                         */
/*--------------------------------------------------------------------*/

} // Namespace STK

#endif
// STK_INX_H