PandA-2024.02
Public Member Functions | Protected Attributes
EvaluationBaseStep Class Reference

Superclass include. More...

#include <evaluation_base_step.hpp>

Inheritance diagram for EvaluationBaseStep:
Inheritance graph
[legend]
Collaboration diagram for EvaluationBaseStep:
Collaboration graph
[legend]

Public Member Functions

 EvaluationBaseStep (const ParameterConstRef parameters, const HLS_managerRef HLSMgr, const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type)
 Constructor. More...
 
 ~EvaluationBaseStep () override
 Destructor. More...
 
bool HasToBeExecuted () const override
 Check if this step has actually to be executed. More...
 
const std::vector< double > & GetEvaluations () const
 Returns the results of the evaluation. More...
 
- Public Member Functions inherited from HLS_step
 HLS_step (const ParameterConstRef _parameters, const HLS_managerRef HLSMgr, const DesignFlowManagerConstRef design_flow_manager, const HLSFlowStep_Type hls_flow_step_type, const HLSFlowStepSpecializationConstRef hls_flow_step_specialization=HLSFlowStepSpecializationConstRef())
 Constructor. More...
 
 ~HLS_step () override
 Destructor. More...
 
std::string GetSignature () const override
 Return a unified identifier of this design step. More...
 
std::string GetName () const override
 Return the name of this design step. More...
 
virtual std::string GetKindText () const
 Return the name of the type of this frontend flow step. More...
 
DesignFlowStepFactoryConstRef CGetDesignFlowStepFactory () const final
 Return the factory to create this type of steps. More...
 
void ComputeRelationships (DesignFlowStepSet &design_flow_step_set, const DesignFlowStep::RelationshipType relationship_type) override
 Compute the relationships of a step with other steps. More...
 
- Public Member Functions inherited from DesignFlowStep
 DesignFlowStep (const DesignFlowManagerConstRef design_flow_manager, const ParameterConstRef parameters)
 Constructor. More...
 
virtual ~DesignFlowStep ()
 Destructor. More...
 
virtual DesignFlowStep_Status Exec ()=0
 Execute the step. More...
 
virtual void Initialize ()
 Initialize the step (i.e., like a constructor, but executed just before exec. More...
 
DesignFlowStep_Status GetStatus () const
 Return the status of this design step. More...
 
virtual void WriteDot (std::ostream &out) const
 Write the label for a dot graph. More...
 
bool IsComposed () const
 Returns if this step is composed. More...
 
int CGetDebugLevel () const
 Return the debug level of the step. More...
 
virtual void PrintInitialIR () const
 Dump the initial intermediate representation. More...
 
virtual void PrintFinalIR () const
 Dump the final intermediate representation. More...
 

Protected Attributes

std::vector< DesignFlowStepRefcost_functions
 List of steps performing evaluations. More...
 
std::vector< HLSFlowStep_Typecost_function_list
 List of objectives that have to be evaluated. More...
 
std::vector< double > evaluations
 store the result of the evaluation More...
 
- Protected Attributes inherited from HLS_step
const HLS_managerRef HLSMgr
 information about all the HLS synthesis More...
 
const HLSFlowStep_Type hls_flow_step_type
 The type of this step. More...
 
const HLSFlowStepSpecializationConstRef hls_flow_step_specialization
 The information about specialization. More...
 
- Protected Attributes inherited from DesignFlowStep
bool composed
 True if this step represents a composition of design flow steps (e.g., a flow); must be set by specialized constructors. More...
 
const Wrefcount< const DesignFlowManagerdesign_flow_manager
 The design flow manager. More...
 
const ParameterConstRef parameters
 Set of input parameters. More...
 
int debug_level
 The debug level. More...
 
const int output_level
 The output level. More...
 

Additional Inherited Members

- Public Types inherited from DesignFlowStep
enum  RelationshipType { DEPENDENCE_RELATIONSHIP, INVALIDATION_RELATIONSHIP, PRECEDENCE_RELATIONSHIP }
 The relationship type. More...
 
- Static Public Member Functions inherited from HLS_step
static std::string EnumToName (const HLSFlowStep_Type hls_flow_step_type)
 Given a HLS flow step type, return the name of the type. More...
 
static const std::string ComputeSignature (const HLSFlowStep_Type hls_flow_step_type, const HLSFlowStepSpecializationConstRef hls_flow_step_specialization)
 Compute the signature of a hls flow step. More...
 
- Protected Member Functions inherited from HLS_step
virtual const CustomUnorderedSet< std::tuple< HLSFlowStep_Type, HLSFlowStepSpecializationConstRef, HLSFlowStep_Relationship > > ComputeHLSRelationships (const DesignFlowStep::RelationshipType relationship_type) const
 Return the set of analyses in relationship with this design step. More...
 
- Static Protected Attributes inherited from HLS_step
static CustomUnorderedMap< std::string, HLSFlowStep_Typecommand_line_name_to_enum
 Map hls step name to enum. More...
 

Detailed Description

Superclass include.

This class is the base class of evaluation steps

Definition at line 49 of file evaluation_base_step.hpp.

Constructor & Destructor Documentation

◆ EvaluationBaseStep()

EvaluationBaseStep::EvaluationBaseStep ( const ParameterConstRef  parameters,
const HLS_managerRef  HLSMgr,
const DesignFlowManagerConstRef  design_flow_manager,
const HLSFlowStep_Type  hls_flow_step_type 
)

Constructor.

Header include.

Parameters
parametersis the set of input parameters is the HLS manager
design_flow_manageris the design flow manager
hls_flow_step_typethe particular type of evaluation

Definition at line 44 of file evaluation_base_step.cpp.

References ~EvaluationBaseStep().

Here is the call graph for this function:

◆ ~EvaluationBaseStep()

EvaluationBaseStep::~EvaluationBaseStep ( )
overridedefault

Destructor.

Referenced by EvaluationBaseStep().

Here is the caller graph for this function:

Member Function Documentation

◆ GetEvaluations()

const std::vector< double > & EvaluationBaseStep::GetEvaluations ( ) const

Returns the results of the evaluation.

Definition at line 58 of file evaluation_base_step.cpp.

References evaluations.

◆ HasToBeExecuted()

bool EvaluationBaseStep::HasToBeExecuted ( ) const
overridevirtual

Check if this step has actually to be executed.

Returns
true if the step has to be executed

Implements DesignFlowStep.

Definition at line 53 of file evaluation_base_step.cpp.

Field Documentation

◆ cost_function_list

std::vector<HLSFlowStep_Type> EvaluationBaseStep::cost_function_list
protected

List of objectives that have to be evaluated.

Definition at line 56 of file evaluation_base_step.hpp.

◆ cost_functions

std::vector<DesignFlowStepRef> EvaluationBaseStep::cost_functions
protected

List of steps performing evaluations.

Definition at line 53 of file evaluation_base_step.hpp.

◆ evaluations

std::vector<double> EvaluationBaseStep::evaluations
protected

store the result of the evaluation

Definition at line 59 of file evaluation_base_step.hpp.

Referenced by GetEvaluations().


The documentation for this class was generated from the following files:

Generated on Mon Feb 12 2024 13:03:50 for PandA-2024.02 by doxygen 1.8.13