Objective.hpp

Go to the documentation of this file.

/*
 * $Id: Objective.hpp 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.
 */

#ifndef IPO_OBJECTIVE_HPP
#define IPO_OBJECTIVE_HPP

#include"detail/ModelFunction.hpp"

namespace ipo {

  class Objective : public detail::Var, public ipo::detail::ModelFunction {
  public:
    Objective( detail::ModelBase& model,
           detail::SharedFunctionPtr function, std::string const& name );
    Objective( detail::ModelBase& model, ipo_function::Function* function,
           std::string const& name );
    Objective( detail::ModelBase& model, ipo_function::Function& function,
           std::string const& name );
    Objective( detail::ModelBase& model, detail::SharedFunctionPtr function,
           char const* const name = 0 );
    Objective( detail::ModelBase& model, ipo_function::Function* function,
           char const* const name = 0 );
    Objective( detail::ModelBase& model, ipo_function::Function& function,
           char const* const name = 0 );
    Objective( Objective const& objective  );
    Objective( Objective&& objective );
    Objective& operator=( Objective const& objective );
    Objective& operator=( Objective&& objective );
    std::string getName() const;
    void setName( std::string const& name );
    void setName( char* const name );
    Array& getVariables();
    void addVariable( Variable& variable );
    void removeVariable( Variable& variable );
    void addArray( Array& array );
    void removeArray( Array& array );
    virtual void summary( std::ostream& ostream = std::cout,
              std::string const& prefix = "" ) const override;
  protected:
    struct Data {
      Data( detail::ModelBase& model );
      std::string name;
      Array variables;
      double lowerBound = minusInfinity;
      double upperBound = infinity;
    };
    double value() const noexcept;
    std::shared_ptr<Data> data;
  };

}

#endif