Bounds.hpp

// Unfit: Data fitting and optimization software
//
// Copyright (C) 2012- Dr Martin Buist & Dr Alberto Corrias
// Contacts: martin.buist _at_ nus.edu.sg; alberto _at_ nus.edu.sg
//
// See the 'Contributors' file for a list of those who have contributed
// to this work.
//
// 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 3 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, see <http://www.gnu.org/licenses/>.
//
#ifndef UNFIT_INCLUDE_BOUNDS_HPP_
#define UNFIT_INCLUDE_BOUNDS_HPP_

#include <vector>

namespace Unfit
{
class Bounds
{
 public:
  Bounds();

  Bounds(std::size_t number_of_bounds);

  void ClampWithinBounds(std::vector<double> &point);

  void GetBounds(std::vector<double> &lower_bound,
      std::vector<double> &upper_bound) const;

  std::size_t GetNumberOfBounds() const noexcept;

  bool IsAboveLowerBound(std::size_t index, double point) const noexcept;

  bool IsBelowUpperBound(std::size_t index, double point) const noexcept;

  bool IsWithinBounds(std::size_t index, double point) const noexcept;

  bool IsWithinBounds(const std::vector<double> &point) const noexcept;

  void ResetBounds();

  bool SetBounds(std::size_t index, double lower_bound, double upper_bound);

  bool SetBounds(const std::vector<double> &lower_bound,
      const std::vector<double> &upper_bound);

  void SetNumberOfBounds(std::size_t number_of_bounds);

  double GetLowerBound(std::size_t index) const noexcept;

  bool SetLowerBound(std::size_t index, double lower_bound);

  double GetUpperBound(std::size_t index) const noexcept;

  bool SetUpperBound(std::size_t index, double upper_bound);

 private:
  std::vector<double> upper_bound_;
  std::vector<double> lower_bound_;
};

}  // namespace Unfit

#endif