Objective.cc

Go to the documentation of this file.

/*
 * $Id: Objective.cc 239 2014-11-30 14:11:47Z 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"Objective.hpp"

using namespace ipo;

Objective::Objective( detail::ModelBase& model,
              detail::SharedFunctionPtr function,
              std::string const& name )
  : Var { model }, ModelFunction { function },
  data{ std::shared_ptr<Data> { new Data { model } } }
{
  data->name = name;
  data->variables.setName( name );
  model.notify();
}

Objective::Objective( detail::ModelBase& model, ipo_function::Function* function,
              std::string const& name )
  : Objective { model, detail::SharedFunctionPtr { function }, name }{}

Objective::Objective( detail::ModelBase& model, ipo_function::Function& function,
              std::string const& name )
  : Objective { model, detail::SharedFunctionPtr { function }, name }{}

Objective::Objective( detail::ModelBase& model, detail::SharedFunctionPtr function,
              char const* const name )
  : Objective { model, function, 0 == name ? std::string {} : name }{}

Objective::Objective( detail::ModelBase& model, ipo_function::Function* function,
              char const* const name )
  : Objective { model, function, 0 == name ? std::string {} : name }{}

Objective::Objective( detail::ModelBase& model, ipo_function::Function& function,
              char const* const name )
  : Objective { model, function, 0 == name ? std::string {} : name }{}

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

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

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

Array&
Objective::getVariables(){
  model.notify();
  return data->variables;
}

Objective::Objective( Objective const& objective  )
  : Var { objective.model }, ModelFunction { objective.function }
{
  data = objective.data;
  model.notify();
}

Objective::Objective( Objective&& objective )
  : Var{ model }, ModelFunction { objective.function }
{
  data = objective.data;
}

Objective&
Objective::operator=( Objective const& objective  ){
  model = objective.model;
  function = objective.function;
  data = objective.data;
  model.notify();
  return *this;
}

Objective&
Objective::operator=( Objective&& objective  ){
  model = objective.model;
  function = objective.function;
  data = objective.data;
  return *this;
}

Objective::Data::Data( detail::ModelBase& model ) : variables( model ){}

void
Objective::addVariable( Variable& variable ){
  try {
    auto& array = getVariables();
    if( std::find( array.begin(), array.end(), variable ) != array.end() ){
      std::ostringstream ost { "ipo::Objective::addVariable(): " };
      ost << "objective or constraint " << getName() << " already contains variable ";
      ost << variable.getName() << ".";
      throw IPOE( ost.str() );
    }
    array.push_back( variable );
  } catch( ... ){
    RETHROW( "ipo::Objective::addVariable()" );
  }
}

void
Objective::removeVariable( Variable& variable ){
  try {
    auto& array = getVariables();
    auto iter = std::find( array.begin(), array.end(), variable );
    if( array.end() == iter ){
      std::ostringstream ost { "ipo::Objective::removeVariable(): " };
      ost << "objective or constraint " << getName() << " does not contain variable ";
      ost << variable.getName() << ".";
      throw IPOE( ost.str() );
    }
    array.erase( iter );
  } catch( ... ){
    RETHROW( "ipo::Objective::removeVariable()" );
  }
}

void
Objective::addArray( Array& array ){
  if( array.getModel() != getModel() ){
    std::ostringstream ost { "ipo::Objective::addArray(): " };
    ost << "array " << array.getName()
    << " must be in same model as " 
    << "objective or constraint " << getName() << ".";
    throw IPOE( ost.str() );
  }
  for( auto& variable : array ){
    auto iter = std::find( getVariables().begin(), getVariables().end(), variable );
    if( getVariables().end() != iter ){
      std::ostringstream ost { "ipo::Objective::addArray(): " };
      ost << "objective or constraint " << getName() << " already contains variable ";
      ost << variable.getName() << ".";
      throw IPOE( ost.str() );
    }
  }
  try {
    for( auto& variable : array ) getVariables().push_back( variable );
  } catch( ... ){
    RETHROW( "ipo::Objective::addArray()" );
  }
}

void
Objective::removeArray( Array& array ){
  if( array.getModel() != getModel() ){
    std::ostringstream ost { "ipo::Objective::removeArray(): " };
    ost << "array " << array.getName()
    << " must be in same model as " 
    << "objective or constraint " << getName() << ".";
    throw IPOE( ost.str() );
  }
  for( auto& variable : array ){
    auto iter = std::find( getVariables().begin(), getVariables().end(), variable );
    if( getVariables().end() == iter ){
      std::ostringstream ost { "ipo::Objective::removeArray(): " };
      ost << "objective or constraint " << getName() << " does not contain variable ";
      ost << variable.getName() << ".";
      throw IPOE( ost.str() );
    }
  }
  try {
    for( auto& variable : array )
      getVariables().erase( std::find( getVariables().begin(),
                       getVariables().end(), variable ) );
  } catch( ... ){
    RETHROW( "ipo::Objective::removeArray()" );
  }
}

void
Objective::summary( std::ostream& ostream, std::string const& prefix ) const {
  ostream << prefix << getName() << " ( ";
  bool first { true };
  for( auto const& e : const_cast<ipo::Objective&>( *this ).getVariables() ){
    if( first ) first = false; else ostream << ", ";
    ostream << e.getName();
  }
  ostream << " ) = " << value() << std::endl;
}

double
Objective::value() const noexcept {
  try {
    Array const& variables { const_cast<Objective&>( *this ).getVariables() };
    size_t const SIZE { variables.size() };
    gsl::vector vector( SIZE );
    for( size_t i { 0 }; i < SIZE; ++i ){
      vector[i] = variables[i].getValue();
    }
    return (*const_cast<Objective&>( *this ).getFunction())( vector );
  } catch( ... ){
    // Return NaN if anything goes wrong
    return std::numeric_limits<double>::quiet_NaN();
  }
}