OpenSTA/util/MinMax.cc

// OpenSTA, Static Timing Analyzer
// Copyright (c) 2026, Parallax Software, Inc.
// 
// 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 <https://www.gnu.org/licenses/>.
// 
// The origin of this software must not be misrepresented; you must not
// claim that you wrote the original software.
// 
// Altered source versions must be plainly marked as such, and must not be
// misrepresented as being the original software.
// 
// This notice may not be removed or altered from any source distribution.

#include "MinMax.hh"

#include <algorithm>
#include <limits>

#include "StringUtil.hh"

namespace sta {

const float INF = 1E+30F;

static bool
compareMin(float value1,
           float value2)
{
  return value1 < value2;
}

static bool
compareMax(float value1,
           float value2)
{
  return value1 > value2;
}

////////////////////////////////////////////////////////////////

const MinMax MinMax::min_("min", 0,  INF, std::numeric_limits<int>::max(), compareMin);
const MinMax MinMax::max_("max", 1, -INF, std::numeric_limits<int>::min(), compareMax);
const std::array<const MinMax*, 2> MinMax::range_{&min_, &max_};
const std::array<size_t, 2> MinMax::range_index_{min_.index(), max_.index()};

MinMax::MinMax(std::string_view name,
               size_t index,
               float init_value,
               int init_value_int,
               bool (*compare)(float value1, float value2)) :
  name_(name),
  index_(index),
  init_value_(init_value),
  init_value_int_(init_value_int),
  compare_(compare)
{
}

const MinMaxAll *
MinMax::asMinMaxAll() const
{
  if (this == &min_)
    return MinMaxAll::min();
  else
    return MinMaxAll::max();
}

const MinMax *
MinMax::opposite() const
{
  if (this == &max_)
    return &min_;
  else
    return &max_;
}

const MinMax *
MinMax::find(std::string_view min_max)
{
  if (stringEqual(min_max, "min")
      || stringEqual(min_max, "early"))
    return &min_;
  else if (stringEqual(min_max, "max")
           || stringEqual(min_max, "late"))
    return &max_;
  else
    return nullptr;
}

const MinMax *
MinMax::find(size_t index)
{
  if (index == min_.index())
    return &min_;
  else if (index == max_.index())
    return &max_;
  else
    return nullptr;
}

bool
MinMax::compare(float value1,
                float value2) const
{
  return compare_(value1, value2);
}

float
MinMax::minMax(float value1,
               float value2) const
{
  if (compare_(value1, value2))
    return value1;
  else
    return value2;
}

////////////////////////////////////////////////////////////////

const MinMaxAll MinMaxAll::min_("min", 0, {MinMax::min()}, {MinMax::min()->index()});
const MinMaxAll MinMaxAll::max_("max", 1, {MinMax::max()}, {MinMax::max()->index()});
const MinMaxAll MinMaxAll::all_("all", 2, {MinMax::min(), MinMax::max()},
                          {MinMax::min()->index(), MinMax::max()->index()});

MinMaxAll::MinMaxAll(std::string_view name,
                     size_t index,
                     const std::vector<const MinMax*> &range,
                     const std::vector<size_t> &range_index) :
  name_(name),
  index_(index),
  range_(range),
  range_index_(range_index)
{
}

const MinMax *
MinMaxAll::asMinMax() const
{
  if (this == &min_)
    return MinMax::min();
  else
    return MinMax::max();
}

bool
MinMaxAll::matches(const MinMax *min_max) const
{
  return this == &all_ || asMinMax() == min_max;
}

bool
MinMaxAll::matches(const MinMaxAll *min_max) const
{
  return this == &all_ || this == min_max;
}

const MinMaxAll *
MinMaxAll::find(const char *min_max)
{
  if (stringEqual(min_max, "min")
      || stringEqual(min_max, "early"))
    return &min_;
  else if (stringEqual(min_max, "max")
           || stringEqual(min_max, "late"))
    return &max_;
  else if (stringEqual(min_max, "all")
           || stringEqual(min_max, "min_max")
           || stringEqual(min_max, "minmax"))
    return &all_;
  else
    return nullptr;
}

} // namespace sta