Variable.hpp

Go to the documentation of this file.

/*
 * $Id: Variable.hpp 226 2014-11-17 17:53:01Z jdl3 $
 * Copyright (C) 2013, 2014 John D Lamb
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU 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
 * General Public License for more details.
 * 
 * You should have received a copy of the GNU General Public License
 * along with this program; if not, write to the Free Software
 * Foundation, Inc., 675 Mass Ave, Cambridge, MA 02139, USA.
 */

#ifndef IPO_VARIABLE_HPP
#define IPO_VARIABLE_HPP

#include<string>
#include<memory>
#include<sstream>
#include<cmath>
#include"detail/Var.hpp"
#include"detail/Format.hpp"

namespace ipo {
  class Variable : public detail::Var {
  public:
    Variable( detail::ModelBase& model, char const* const name = nullptr );
    Variable( detail::ModelBase& model, std::string const& name );
    double getValue() const;
    std::string getName() const;
    void setName( std::string const& name );
    void setName( char* const name );
    double getUpperBound() const;
    double getLowerBound() const;
    void setValue( double const value );
    void setUpperBound( double const upperBound );
    void setLowerBound( double const lowerBound );
    Variable( Variable const& variable );
    Variable& operator=( Variable const& variable );
    Variable( Variable&& variable ) : Var( variable.model ), data( variable.data ){}
    Variable& operator=( Variable&& variable );
    virtual void summary( std::ostream& ostream = std::cout,
              std::string const& prefix = "" ) const override;
  private:
    struct Data {
      double value;
      std::string name;
      double lowerBound;
      double upperBound;
    };
    std::shared_ptr<Data> data;
    // Friend declarations
    friend bool ipo::operator==( Variable const&, Variable const& );
    friend bool ipo::operator<( Variable const&, Variable const& );
  };

  bool operator==( Variable const& lhs, Variable const& rhs );
  bool operator<( Variable const& lhs, Variable const& rhs );

}

#endif