/home/mine/apron/apronxx/apxx_var.hh

Go to the documentation of this file.

/* -*- C++ -*-
 * apxx_var.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_VAR_HH
#define __APXX_VAR_HH
 
#include "ap_var.h"
 
 
namespace apron {
 
 
/* ================================= */
/* var                               */
/* ================================= */
 


 * Variable names replace dimensions in all level 1 operations.
 * Variable names can be copied, freed, compared, and converted to string.
 * The actual implementation of these operators is defined using the global pointer ap_var_operations.
 * By default, ap_var_operations implements dynamically allocated C-style 
 * NULL-terminated strings.
 */
class var {
  
protected:
  ap_var_t v; 
  
public:
  
  /* constructors */
  /* ============ */


  var(const void* x);
  
  var(const std::string& x);
  
  var(const var& x);

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

  
  ~var();
  
  //@}
 
 
  /* assignments */
  /* =========== */



  var& operator=(const var& x);
  
  var& operator=(const std::string& x);
  

  var& operator=(const void* x);
  
 
 
  /* conversions */
  /* =========== */


   *
   * The C string should be freed with malloc by the caller.
   */
  operator char*() const;

  //! \brief Converts to a C++ string (calls ap_var_operations->to_string).
  operator std::string() const;

 
 
  /* comparisons */
  /* =========== */


  //@{

  friend int  compare(const var& x, const var& y);

  //! \brief Compares two variables names (calls ap_var_operations->to_compare).
  friend bool operator==(const var& x, const var& y);

  friend bool operator!=(const var& x, const var& y);
 
  friend bool operator>=(const var& x, const var& y);


  friend bool operator<=(const var& x, const var& y);

  friend bool operator>(const var& x, const var& y);

  friend bool operator<(const var& x, const var& y);

  //@}
 
 
  /* print */
  /* ===== */

  /** @name Printing */

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


  void print(FILE* stream=stdout) const;

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



  const ap_var_t& get_ap_var_t() const;


  ap_var_t& get_ap_var_t();

 
};
 
#include "apxx_var_inline.hh"
 
}
 
 
#endif /* __APXX_VAR_HH */