// OpenSTA, Static Timing Analyzer
// Copyright (c) 2019, 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/>.

#ifndef STA_DERATING_FACTORS_H
#define STA_DERATING_FACTORS_H

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

namespace sta {

class DeratingFactors
{
public:
  DeratingFactors();
  void setFactor(PathClkOrData clk_data,
		 const TransRiseFallBoth *tr,
		 const EarlyLate *early_late,
		 float factor);
  void factor(PathClkOrData clk_data,
	      const TransRiseFall *tr,
	      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:
  DISALLOW_COPY_AND_ASSIGN(DeratingFactors);

  RiseFallMinMax factors_[path_clk_or_data_count];
};

class DeratingFactorsGlobal
{
public:
  DeratingFactorsGlobal();
  void setFactor(TimingDerateType type,
		 PathClkOrData clk_data,
		 const TransRiseFallBoth *tr,
		 const EarlyLate *early_late,
		 float factor);
  void factor(TimingDerateType type,
	      PathClkOrData clk_data,
	      const TransRiseFall *tr,
	      const EarlyLate *early_late,
	      float &factor,
	      bool &exists) const;
  DeratingFactors *factors(TimingDerateType type);
  void clear();

private:
  DISALLOW_COPY_AND_ASSIGN(DeratingFactorsGlobal);

  DeratingFactors factors_[timing_derate_type_count];
};

class DeratingFactorsCell
{
public:
  DeratingFactorsCell();
  void setFactor(TimingDerateType type,
		 PathClkOrData clk_data,
		 const TransRiseFallBoth *tr,
		 const EarlyLate *early_late,
		 float factor);
  void factor(TimingDerateType type,
	      PathClkOrData clk_data,
	      const TransRiseFall *tr,
	      const EarlyLate *early_late,
	      float &factor,
	      bool &exists) const;
  DeratingFactors *factors(TimingDerateType type);
  void clear();
  void isOneValue(const EarlyLate *early_late,
		  bool &is_one_value,
		  float &value) const;

private:
  DISALLOW_COPY_AND_ASSIGN(DeratingFactorsCell);

  DeratingFactors factors_[timing_derate_cell_type_count];
};

class DeratingFactorsNet : public DeratingFactors
{
public:
  DeratingFactorsNet();

private:
  DISALLOW_COPY_AND_ASSIGN(DeratingFactorsNet);
};

} // namespace
#endif
