lp.hpp

Go to the documentation of this file.

#ifndef LPINTERFACE_LP_H
#define LPINTERFACE_LP_H

#include <iostream>
#include <vector>

#include "data_objects.hpp"
#include "errors.hpp"

#include "common.hpp"

namespace lpint {

enum class OptimizationType {
  Minimize,
  Maximize,
};

// LCOV_EXCL_START
inline std::ostream& operator<<(std::ostream& os, const OptimizationType ot) {
  switch (ot) {
    case (OptimizationType::Maximize):
      os << "Maximize";
      break;
    case (OptimizationType::Minimize):
      os << "Minimize";
      break;
    default:
      // TODO: make a more descriptive exception
      // for this case
      throw UnsupportedFeatureException();
  }
  return os;
}
// LCOV_EXCL_STOP

class ILinearProgramHandle {
 public:
  ILinearProgramHandle() = default;
  ILinearProgramHandle(const ILinearProgramHandle&) = default;
  ILinearProgramHandle(ILinearProgramHandle&&) = default;
  ILinearProgramHandle& operator=(const ILinearProgramHandle&) = default;
  ILinearProgramHandle& operator=(ILinearProgramHandle&&) = default;

  virtual ~ILinearProgramHandle() = default;

  virtual std::size_t num_vars() const = 0;

  virtual std::size_t num_constraints() const = 0;

  virtual void set_objective_sense(const OptimizationType objsense) = 0;

  virtual Variable variable(std::size_t i) const = 0;

  virtual std::vector<Variable> variables() const = 0;

  virtual void add_variables(const std::vector<Variable>& vars) = 0;

  virtual void add_variables(const std::size_t num_vars) = 0;

  virtual void add_constraints(
      const std::vector<Constraint<double>>& constraints) = 0;

  virtual void remove_constraint(const std::size_t i) = 0;

  virtual void remove_variable(const std::size_t i) = 0;

  virtual OptimizationType optimization_type() const = 0;

  virtual void set_objective(const Objective<double>& objective) = 0;

  virtual Constraint<double> constraint(std::size_t i) const = 0;

  virtual std::vector<Constraint<double>> constraints() const = 0;

  virtual Objective<double> objective() const = 0;
};

}  // namespace lpint

#endif  // LPINTERFACE_LP_H