/home/mine/apron/apronxx/apxx_dimension.hh

Go to the documentation of this file.

/* -*- C++ -*-
 * apxx_dimension.hh
 *
 * APRON Library / C++ class wrappers
 *
 * Copyright (C) Antoine Mine' 2007
 *
 */
/* This file is part of the APRON Library, released under LGPL license
   with an exception allowing the redistribution of statically linked
   executables.
 
   Please read the COPYING file packaged in the distribution.
*/
 
#ifndef __APXX_DIMENSION_HH
#define __APXX_DIMENSION_HH
 
#include "ap_dimension.h"
 
 
namespace apron {
 
 
/* ================================= */
/* varname                           */
/* ================================= */


class varname {
 
protected:

  static const int xindex;

  const std::vector<std::string>& names;
 
public:

   * If there are not enough names, printing functions will revert to
   * xi, xi+1... To disable variable names, simply pass an empty vector.
   *
   * A reference to \c names is kept by the object and will be passed to the
   * stream by the modifier. The stream will then make a deep copy and the
   * varname object and the original vector can be safely deleted.
   * 
   */
  varname(const std::vector<std::string>& names);


  template<class charT, class Traits>
  friend
  std::basic_ostream<charT,Traits>& 
  operator<<(std::basic_ostream<charT,Traits>& os, const varname& v);


   * \return a pointer to the vector formerly associated to the
   * stream, or NULL.
   */
  template<class charT, class Traits>
  friend
  std::vector<std::string>* get_varname(std::basic_ostream<charT,Traits>& os);
 
};
 
 
 
 
/* ================================= */
/* dimchange                         */
/* ================================= */
 


 * an array of indices where to add/remove dimensions.
 * The array should be sorted in increasing order.
 */
class dimchange : public use_malloc {
 
protected:
 
  ap_dimchange_t c; 
 
public:
 
  /* constructor */
  /* =========== */



  dimchange(size_t intdim=0, size_t realdim=0);

  dimchange(size_t intdim, size_t realdim, const ap_dim_t d[]);

   * \exception std::invalid_argument if d contains less than intdim+realdim dimensions.
   */
  dimchange(size_t intdim, size_t realdim, const std::vector<ap_dim_t>& d);


   *
   * \arg inv if inv==true, then the constructed dimchange is the inverse of x (see add_invert).
   */
  dimchange(const dimchange& x, bool inv=false);

  //@}
 
 
  /* destructor */
  /* ========== */

  /** @name Destructor */
 
  ~dimchange();


  
 
  /* assignment */
  /* ========== */

  /** @name Assignments */

  dimchange& operator= (const dimchange& x);

   */
  dimchange& operator= (const ap_dim_t d[]);

  dimchange& operator= (const std::vector<ap_dim_t>& d);

 
 
  /* access */
  /* ====== */



  size_t get_intdim() const;


  size_t get_realdim() const;

   * \arg \c dim should be strictly smaller than intdim+realdim (not bound-checked).
   */
  ap_dim_t& operator[](size_t dim);


   *
   * \arg \c dim should be strictly smaller than intdim+realdim (not bound-checked).
   */
  const ap_dim_t& operator[](size_t dim) const;


  ap_dim_t& get(size_t dim);

  /*! \brief Returns a reference to a (checked) index in the underlying array (bound-checked).
   *
   * \exception std::out_of_range is thrown if dim>=intdim+realdim.
   */
  const ap_dim_t& get(size_t dim) const;
  
 
 
  /* print */
  /* ===== */


  friend std::ostream& operator<< (std::ostream& os, const dimchange& s); 

  void print(FILE* stream=stdout) const;

  //@}
 
 
 
  /* other operators */
  /* =============== */



   * If the dimchange was used to add some dimensions, it can now be used to remove the
   * added dimensions (but not the converse).
   */
  void add_invert();


   * See \c add_invert.
   */
  dimchange operator- () const;

 
 
  /* C-level compatibility */
  /* ===================== */


  const ap_dimchange_t* get_ap_dimchange_t() const;

  ap_dimchange_t* get_ap_dimchange_t();

};
 
 

struct id {
  size_t size; 
 
  id(size_t size) : size(size) {}
};
 
 
 
/* ================================= */
/* dimperm                           */
/* ================================= */
 

/*! \brief Dimension permutation object (ap_dimperm_t wrapper).
 *
 * dimperm objects can be used to permute dimensions in expressions, constraints, and domains.
 * They hold a map i->p[i]: [0,size-1]=>[0,size-1] using an array p of dimensions.
 * All the p[i] must be distinct and in the range [0,size-1] where size is the size of p.
 */
class dimperm : public use_malloc {
 
protected:
 
  ap_dimperm_t c;  
 
public:
 
 
  /* constructor */
  /* =========== */


  dimperm(size_t size=0);


  dimperm(size_t size, const ap_dim_t d[]);

  //! Makes a dimperm initialized with the vector d.
  dimperm(const std::vector<ap_dim_t>& d);
 


  dimperm(id t);


   */
  dimperm(const dimperm& x, bool inv=false);

  dimperm(const dimperm& x, const dimperm& y);

 
 
  /* destructor */
  /* ========== */

 
  ~dimperm();

  
 
  /* assignment */
  /* ========== */


  dimperm& operator= (const dimperm& x);

  dimperm& operator= (id t);

  dimperm& operator= (const ap_dim_t d[]);

  dimperm& operator= (const std::vector<ap_dim_t>& d);

 
 
  /* access */
  /* ====== */



  size_t size() const;

   *
   * \arg \c dim should be strictly smaller than size (not bound-checked).
   */
  ap_dim_t& operator[](size_t dim);

  const ap_dim_t& operator[](size_t dim) const;
 

   * \exception std::out_of_range is thrown if dim>=size.
   */
  ap_dim_t& get(size_t dim);
 
  const ap_dim_t& get(size_t dim) const;

 
 
  /* print */
  /* ===== */
  


  friend std::ostream& operator<< (std::ostream& os, const dimperm& s); 

  void print(FILE* stream=stdout) const;

 
 
  /* other operators */
  /* =============== */


  //@{
 
  /* composition */


  dimperm& operator*= (const dimperm& y);

  friend dimperm operator* (const dimperm& x, const dimperm& y);
 
 
 
  /* inversion */

  void invert();

  dimperm operator- () const;

 
 
  /* C-level compatibility */
  /* ===================== */


  const ap_dimperm_t* get_ap_dimperm_t() const;

  ap_dimperm_t* get_ap_dimperm_t();

 
};
 
#include "apxx_dimension_inline.hh"
 
}
 
#endif /* __APXX_DIMENSION_HH */