Variable.cc

Go to the documentation of this file.

/*
 * $Id: Variable.cc 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.
 */

#ifdef HAVE_CONFIG_H
#  include<config.h>
#endif

#include"Variable.hpp"

using namespace ipo;

Variable::Variable( detail::ModelBase& model, char const* const name )
  : Variable { model, nullptr == name ? std::string() : std::string { name } }{
  model.notify();
}

Variable::Variable( detail::ModelBase& model, std::string const& name )
  : Var { model }, data { std::shared_ptr<Data>{ new Data } }
{
  data->value = 0;
  data->name = name;
  data->upperBound = infinity;
  data->lowerBound = minusInfinity;
  model.notify();
}

double
Variable::getValue() const {
  return data->value;
}

std::string
Variable::getName() const {
  return data->name;
}

double
Variable::getUpperBound() const {
  return data->upperBound;
}

double
Variable::getLowerBound() const {
  return data->lowerBound;
}

void
Variable::setValue( double const value ){
  if( value < getLowerBound() ){
    std::ostringstream error;
    error << "ipo::Variable::set(): value ";
    error << value << " less than lower bound ";
    error << getLowerBound() << ".";
    throw IPOE( error.str() );
  } else if( value > getUpperBound() ){
    std::ostringstream error;
    error << "ipo::Variable::set(): value ";
    error << value << " greater than upper bound ";
    error << getUpperBound() << ".";
    throw IPOE( error.str() );
  }
  data->value = value;
}

void
Variable::setName( std::string const& name ){
  data->name = name;
}

void
Variable::setName( char* const name ){
  data->name = nullptr == name ? std::string {} : std::string { name };
}

void
Variable::setUpperBound( double const upperBound ){
  if( upperBound < getLowerBound() ){
    std::ostringstream error;
    error << "ipo::Variable::setUpperBound(): upper bound ";
    error << upperBound << " less than lower bound ";
    error << getLowerBound() << ".";
    throw IPOE( error.str() );
  }
  data->upperBound = upperBound;
  data->value = std::min( getValue(), upperBound );
}

void
Variable::setLowerBound( double const lowerBound ){
  if( lowerBound > getUpperBound() ){
    std::ostringstream error;
    error << "ipo::Variable::setLowerBound(): lower bound ";
    error << lowerBound << " greater than upper bound ";
    error << getUpperBound() << ".";
    throw IPOE( error.str() );
  }
  data->lowerBound = lowerBound;
  data->value = std::max( getValue(), lowerBound );
}

bool
ipo::operator==( Variable const& lhs, Variable const& rhs ){
  return lhs.data == rhs.data;
}

bool
ipo::operator<( Variable const& lhs, Variable const& rhs ){
  return lhs.data.get() < rhs.data.get();
}

Variable&
Variable::operator=( Variable const& variable ){
  if( &variable.model != &model )
    throw IPOE( "ipo::Variable::operator=(): cannot assign variable to different model." );
  data = variable.data;
  return *this;
}

Variable::Variable( Variable const& variable ) 
  : Var( variable.model ), data( variable.data ){
  // Two references for same variable
}

Variable&
Variable::operator=( Variable&& variable ){
  if( &variable.model != &model )
    throw IPOE( "ipo::Variable::operator=(): cannot assign variable to different model." );
  data = variable.data;
  return *this;
}

void
Variable::summary( std::ostream& ostream, std::string const& prefix ) const {
  auto f = [](double x)->std::string {
    std::ostringstream ost;
    double a { std::fabs( x ) };
    if( x < 0 ) ost << "−";
    if( a == std::numeric_limits<double>::infinity() )
      ost << "∞";
    else
      ost << x;
    return ost.str();
  };
  ostream << prefix << getName() << " = " << getValue()
      << " (" << f( getLowerBound() ) << " ≤ " << getName() << " ≤ "
      << f( getUpperBound() ) << ")" << std::endl;
}