// 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.

#pragma once

#include "LibertyClass.hh"
#include "MinMax.hh"
#include "RiseFallMinMax.hh"
#include "SdcClass.hh"

namespace sta {

class DeratingFactors
{
public:
  DeratingFactors();
  void setFactor(PathClkOrData clk_data,
                 const RiseFallBoth *rf,
                 const EarlyLate *early_late,
                 float factor);
  void factor(PathClkOrData clk_data,
              const RiseFall *rf,
              const EarlyLate *early_late,
              float &factor,
              bool &exists) const;
  void clear();
  void isOneValue(const EarlyLate *early_late,
                  bool &is_one_value,
                  float &value) const;
  void isOneValue(PathClkOrData clk_data,
                  const EarlyLate *early_late,
                  bool &is_one_value,
                  float &value) const;
  bool hasValue() const;

private:
  RiseFallMinMax factors_[path_clk_or_data_count];
};

class DeratingFactorsGlobal
{
public:
  DeratingFactorsGlobal();
  void setFactor(TimingDerateType type,
                 PathClkOrData clk_data,
                 const RiseFallBoth *rf,
                 const EarlyLate *early_late,
                 float factor);
  void factor(TimingDerateType type,
              PathClkOrData clk_data,
              const RiseFall *rf,
              const EarlyLate *early_late,
              float &factor,
              bool &exists) const;
  void factor(TimingDerateCellType type,
              PathClkOrData clk_data,
              const RiseFall *rf,
              const EarlyLate *early_late,
              float &factor,
              bool &exists) const;
  DeratingFactors *factors(TimingDerateType type);
  void clear();

private:
  DeratingFactors factors_[timing_derate_type_count];
};

class DeratingFactorsCell
{
public:
  DeratingFactorsCell();
  void setFactor(TimingDerateCellType type,
                 PathClkOrData clk_data,
                 const RiseFallBoth *rf,
                 const EarlyLate *early_late,
                 float factor);
  void factor(TimingDerateCellType type,
              PathClkOrData clk_data,
              const RiseFall *rf,
              const EarlyLate *early_late,
              float &factor,
              bool &exists) const;
  DeratingFactors *factors(TimingDerateCellType type);
  void clear();
  void isOneValue(const EarlyLate *early_late,
                  bool &is_one_value,
                  float &value) const;

private:
  DeratingFactors factors_[timing_derate_cell_type_count];
};

} // namespace sta
