A class representing a structural candidate for module identification. More...

#include </home/runner/work/hal/hal/plugins/module_identification/include/module_identification/candidates/structural_candidate.h>

Collaboration diagram for hal::module_identification::StructuralCandidate:

Public Member Functions
	StructuralCandidate (BaseCandidate base_candidate_in, const std::vector< Gate > &gates_in)
	Constructor for StructuralCandidate. More...

Public Attributes
BaseCandidate *	base_candidate
	Pointer to the base candidate. More...

std::vector< Gate * >	m_gates
	Vector of gates that form the structural candidate. More...

CandidateContext	ctx
	Candidate context for the structural candidate. More...

Detailed Description

A class representing a structural candidate for module identification.

This class holds information about a structural candidate, including its base candidate, the gates involved, and the candidate context. It serves as a structural variant built around the base candidate, which is used for further analysis and identification of modules within a netlist.

Definition at line 53 of file structural_candidate.h.

Constructor & Destructor Documentation

◆ StructuralCandidate()

hal::module_identification::StructuralCandidate::StructuralCandidate	(	BaseCandidate *	base_candidate_in,
		const std::vector< Gate * > &	gates_in
	)

inline

Constructor for StructuralCandidate.

Initializes a structural candidate with a given base candidate and a vector of gates. It also creates a candidate context.

Parameters

[in]	base_candidate_in	- Pointer to the base candidate.
[in]	gates_in	- Vector of gates that form the structural candidate.

Definition at line 64 of file structural_candidate.h.

Member Data Documentation

◆ base_candidate

BaseCandidate* hal::module_identification::StructuralCandidate::base_candidate

Pointer to the base candidate.

Definition at line 70 of file structural_candidate.h.

Referenced by hal::module_identification::FunctionalCandidate::FunctionalCandidate(), and hal::module_identification::generate_functional_candidates().

◆ ctx

CandidateContext hal::module_identification::StructuralCandidate::ctx

Candidate context for the structural candidate.

Definition at line 80 of file structural_candidate.h.

Referenced by hal::module_identification::generate_functional_candidates().

◆ m_gates

std::vector<Gate*> hal::module_identification::StructuralCandidate::m_gates

Vector of gates that form the structural candidate.

Definition at line 75 of file structural_candidate.h.

Referenced by hal::module_identification::FunctionalCandidate::create_candidates(), hal::module_identification::FunctionalCandidate::FunctionalCandidate(), and hal::module_identification::generate_functional_candidates().

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

plugins/module_identification/include/module_identification/candidates/structural_candidate.h

Public Member Functions