C++ API Reference¶

File Hierarchy¶

- Directory src
  - Directory partition
    - Directory refine
      - Directory bucket
        File MoveBucket.h
      - Directory core
        File RefinementContext.h
        File RefinementRunTypes.h
        File RefineTypes.h
      - Directory engine
        File GainEvaluator.h
        File MoveApplier.h
      - Directory pipeline
        File CandidatePoolService.h
        File CandidateProjectionService.h
        File CandidateSelector.h
        File FPGARemapper.h
        File StrategyPlanner.h
        File StrategyRunner.h
        File TimingMetricService.h
      - Directory strategy
        File IRefineStrategy.h
        File LegacyRefine.h
        File StrategyFactory.h
      - File RefinementFacade.h
    - File coarsen.h
    - File defs.h
    - File evaluator.h
    - File initial.h
    - File partition.h
    - File tools.h
  - Directory routing
    - File routing.h
  - Directory sta
    - File HSBaseObj.h
    - File HSCutNetFlow.h
    - File HSCutOnlyFlow.h
    - File HSGraphClock.h
    - File HSIOTdmDelay.h
    - File HSOuterEdge.h
    - File HSPartitionFlow.h
    - File HSPrefixTree.h
    - File HSStaBase.h
    - File HSTimingDelta.h
    - File HSTimingEdge.h
    - File HSTimingLocalData.h
    - File HSTimingSlackRange.h
    - File HSTimingUndo.h
    - File sta.h
  - Directory tdm
    - File delay_lib.h
    - File tdm.h

Full API¶

Namespaces¶

Namespace Eigen

Namespace HSFullTiming

Namespace kahypar
- Classes

Namespace routing_flow
- Functions

Namespace std
- Classes

Namespace tdm
- Functions

Classes and Structs¶

Struct CandidateBuffers
- Struct Documentation
  - CandidateBuffers

Struct CandidateRefinementRequest
- Struct Documentation
  - CandidateRefinementRequest

Struct ChannelStatus
- Struct Documentation
  - ChannelStatus

Struct CoarsenConfig
- Struct Documentation
  - CoarsenConfig

Struct ContractedHyperedgeInformation
- Struct Documentation
  - ContractedHyperedgeInformation
    - he
    - hash
    - size
    - valid

Struct cpAttr
- Struct Documentation
  - cpAttr

Struct curPartStatus
- Struct Documentation
  - curPartStatus

Struct CutMatrixResultCore
- Struct Documentation
  - CutMatrixResultCore

Struct CutTimingPathInfo
- Struct Documentation
  - CutTimingPathInfo
    - index
    - cp
    - old_slack
    - ratios
    - die_hop
    - new_slack
    - delay_real_sum
    - delay_sum

Struct DomainStat
- Struct Documentation
  - DomainStat
    - cp
    - slack_min

Struct Edge
- Struct Documentation
  - Edge
    - u
    - v
    - uv_disabled
    - vu_disabled
    - uv_flow
    - vu_flow
    - capacity
    - gio_capacity

Struct EdgeSnap
- Struct Documentation
  - EdgeSnap

Struct EdgeStat
- Struct Documentation
  - EdgeStat
    - id
    - crit
    - r_cont
    - r_disc

Struct GainComponents
- Struct Documentation
  - GainComponents
    - cm
    - topo_gain
    - io_gain
    - cut_gain

Struct GainEvaluatorContext
- Struct Documentation
  - GainEvaluatorContext

Struct hash_pair
- Struct Documentation
  - hash_pair
    - operator()()

Struct hashfunc
- Struct Documentation
  - hashfunc
    - operator()()

Struct HierarchyLink
- Struct Documentation
  - HierarchyLink

Struct HierarchyLinkEndpoint
- Struct Documentation
  - HierarchyLinkEndpoint

Struct HierarchyPartitionCutRecord
- Struct Documentation
  - HierarchyPartitionCutRecord

Struct edge_info
- Struct Documentation
  - HSFullTiming::edge_info

Struct EnableUndo
- Struct Documentation
  - HSFullTiming::EnableUndo
    - edgeId
    - oldEnable

Struct HSCutNetFlow::cut_net
- Nested Relationships
- Struct Documentation

Struct HSCutNetFlow::CutNetInfo
- Nested Relationships
- Struct Documentation

Struct HSCutNetFlow::CutNetKey
- Nested Relationships
- Struct Documentation

Struct HSCutNetFlow::CutNetTimingPath
- Nested Relationships
- Struct Documentation

Struct HSPartitionNet
- Struct Documentation
  - HSFullTiming::HSPartitionNet
    - m_parts
    - m_edgeIds

Struct HSStaBase::timingpath
- Nested Relationships
- Struct Documentation

Struct HSTimingDelta::traceInfo
- Nested Relationships
- Struct Documentation

Struct HSTimingLocalData::traceInfo
- Nested Relationships
- Struct Documentation

Struct pfxtNode
- Struct Documentation
  - HSFullTiming::pfxtNode
    - nodeId
    - clkId
    - slack
    - hop
    - fromEdgeId
    - toEdgeId
    - parentId
    - poped

Struct PTNet
- Struct Documentation
  - HSFullTiming::PTNet
    - m_nodes
    - m_netNum

Struct slackData
- Struct Documentation
  - HSFullTiming::slackData
    - slackPre
    - slackPost
    - edgePreId
    - edgePostId
    - clkId
    - hopPre
    - hopPost

Struct SlackUndo
- Struct Documentation
  - HSFullTiming::SlackUndo
    - side
    - p
    - oldHop
    - oldSlack
    - oldEdgeId

Struct InitialPartitionConfig
- Struct Documentation
  - InitialPartitionConfig
    - num_initial_solutions

Struct SparseMapBase::MapElement
- Nested Relationships
- Struct Documentation

Struct LevelWorkset
- Struct Documentation
  - LevelWorkset

Struct LibMeta
- Struct Documentation
  - LibMeta
    - rmin
    - rmax
    - choices
    - has_bounds

Struct LibModel
- Struct Documentation
  - LibModel

Struct LinearModel
- Struct Documentation
  - LinearModel
    - eval()
    - a
    - b
    - valid

Struct mesh
- Struct Documentation
  - mesh
    - operator<()
    - id
    - distance
    - cutweight
    - prev

Struct Metrics
- Struct Documentation
  - Metrics
    - cut
    - tdm
    - topo
    - violation
    - cost
    - worstSlack
    - maxHop
    - tdmDelay
    - topkratio

Struct MgtSubChannel
- Struct Documentation
  - MgtSubChannel
    - clock
    - used

Struct MoveApplierContext
- Struct Documentation
  - MoveApplierContext

Struct mulClockAttr
- Struct Documentation
  - mulClockAttr

Struct PartitionConstraintConfig
- Struct Documentation
  - PartitionConstraintConfig

Struct PartitionFlowConfig
- Struct Documentation
  - PartitionFlowConfig

Struct PartitionParams
- Struct Documentation
  - PartitionParams
    - flow
    - constraints
    - coarsen
    - initial
    - refine
    - timing

Struct PartitionState
- Struct Documentation
  - PartitionState

Struct PendingEdge
- Struct Documentation
  - PendingEdge
    - u
    - v
    - times
    - tdm
    - tdm_real

Struct pinSlack
- Struct Documentation
  - pinSlack
    - slack
    - cp
    - pinPreId
    - pinPostId
    - to_json
    - from_json

Struct pq
- Struct Documentation
  - pq
    - operator<()
    - x
    - y
    - z

Struct PWLModel
- Struct Documentation
  - PWLModel
    - eval()
    - slopeAt()
    - xs
    - ys
    - slopes
    - valid
    - fromPoints()

Struct RefinementConfig
- Struct Documentation
  - RefinementConfig

Struct RefinementRunState
- Struct Documentation
  - RefinementRunState

Struct RefinementSession
- Struct Documentation
  - RefinementSession

Struct RefinePassContext
- Struct Documentation
  - RefinePassContext

Struct RefineStageConfig
- Struct Documentation
  - RefineStageConfig

Struct RoutingParams
- Struct Documentation
  - RoutingParams

Struct ScopedLibModels
- Struct Documentation
  - ScopedLibModels
    - has_gio
    - has_mgt
    - gio
    - mgt
    - gio_meta
    - mgt_meta

Struct SimpleTiming
- Struct Documentation
  - SimpleTiming

Struct SlackStat
- Struct Documentation
  - SlackStat

Template Struct hash< cut_timing_path >
- Struct Documentation
  - std::hash< cut_timing_path >
    - operator()()

Struct StrategyPlan
- Struct Documentation
  - StrategyPlan

Struct TimingPath
- Struct Documentation
  - TimingPath
    - TimingPath()
    - TimingPath()
    - path
    - arcs
    - slack
    - slack_new
    - cp
    - slack_old
    - slack_new_abolute
    - cut
    - dHop
    - index
    - is_path_in_cell

Struct TimingPathCompare
- Struct Documentation
  - TimingPathCompare
    - operator()()

Struct TimingRefineConfig
- Struct Documentation
  - TimingRefineConfig

Struct TypedSockets
- Struct Documentation
  - TypedSockets

Struct WorstInfo
- Struct Documentation
  - WorstInfo

Struct WorstPathCache
- Struct Documentation
  - WorstPathCache
    - worst_sink
    - worst_delay
    - edges
    - nodes
    - desc

Class bidir_map
- Class Documentation
  - bidir_map

Class CandidatePoolService
- Class Documentation
  - CandidatePoolService

Class CandidateProjectionService
- Class Documentation
  - CandidateProjectionService

Class CandidateSelector
- Class Documentation
  - CandidateSelector
    - chooseBestCandidate()

Class comb_set
- Class Documentation
  - comb_set
    - comb_set()
    - merge()
    - getfa()
    - fa

Class CompositeConstraintChecker
- Inheritance Relationships
  - Base Type
- Class Documentation
  - CompositeConstraintChecker
    - canMove()

Class ConstraintCheckerCore
- Class Documentation
  - ConstraintCheckerCore
    - checkBalance()
    - checkMove()

Class cut_net
- Class Documentation
  - cut_net

Class cut_timing_path
- Class Documentation
  - cut_timing_path
    - operator==()
    - path
    - arcs
    - path_arcs
    - timing_edges
    - orig_tp_id
    - cut
    - die_cut
    - slack
    - slack_old
    - cut_slack
    - cut_slack_old
    - cp
    - clock_domain

Class DieConnection
- Class Documentation
  - DieConnection

Class DisjointSet
- Class Documentation
  - DisjointSet
    - DisjointSet()
    - size_()
    - find()
    - union_()
    - list()
    - parent
    - size

Class DSFM_M_Refine
- Inheritance Relationships
  - Base Types
- Class Documentation
  - DSFM_M_Refine

Class DSFM_S_Refine
- Inheritance Relationships
  - Base Types
- Class Documentation
  - DSFM_S_Refine

Class fixInfo
- Class Documentation
  - fixInfo
    - fpgaNo
    - id

Class FMLikeStrategyBase
- Inheritance Relationships
  - Base Type
- Class Documentation
  - FMLikeStrategyBase

Class FMRefine
- Inheritance Relationships
  - Base Types
- Class Documentation
  - FMRefine

Class FPGARemapper
- Class Documentation
  - FPGARemapper

Class Gain
- Class Documentation
  - Gain

Class GainEvaluatorCore
- Class Documentation
  - GainEvaluatorCore

Class GlobalMoveBucket
- Class Documentation
  - GlobalMoveBucket

Class graph
- Class Documentation
  - graph

Class GreedyRefine
- Inheritance Relationships
  - Base Types
- Class Documentation
  - GreedyRefine

Class hierarchy
- Class Documentation
  - hierarchy

Class HSBaseObj
- Inheritance Relationships
  - Derived Types
- Class Documentation
  - HSFullTiming::HSBaseObj

Class HSCutNetFlow

Class HSGraphClock
- Inheritance Relationships
  - Base Type
- Class Documentation
  - HSFullTiming::HSGraphClock

Class HSOuterEdge
- Inheritance Relationships
  - Base Type
- Class Documentation
  - HSFullTiming::HSOuterEdge

Class HSPartitionFlow
- Inheritance Relationships
  - Base Type
  - Derived Types
- Class Documentation
  - HSFullTiming::HSPartitionFlow

Class HSTimingDelta
- Nested Relationships
  - Nested Types
- Class Documentation
  - HSFullTiming::HSTimingDelta

Class HSTimingEdge
- Class Documentation
  - HSFullTiming::HSTimingEdge

Class HSTimingLocalData
- Nested Relationships
  - Nested Types
- Class Documentation
  - HSFullTiming::HSTimingLocalData

Class IMoveConstraintChecker
- Inheritance Relationships
  - Derived Type
- Class Documentation
  - IMoveConstraintChecker
    - ~IMoveConstraintChecker()
    - canMove()

Class IRefineStrategy
- Inheritance Relationships
  - Derived Types
- Class Documentation
  - IRefineStrategy

Template Class SparseMap
- Inheritance Relationships
  - Base Type
- Class Documentation
  - kahypar::SparseMap

Class MoveStateApplierCore
- Class Documentation
  - MoveStateApplierCore

Class net
- Class Documentation
  - net

Class NetPartition
- Class Documentation
  - NetPartition
    - src
    - src_part
    - nums

Class node
- Class Documentation
  - node
    - operator>()
    - add()
    - substract()
    - weight
    - begin
    - size
    - resources

Class OldRefine
- Inheritance Relationships
  - Base Types
- Class Documentation
  - OldRefine

Class PerPartBucketSet
- Class Documentation
  - PerPartBucketSet

Class PMRefine
- Inheritance Relationships
  - Base Types
- Class Documentation
  - PMRefine

Class range
- Class Documentation
  - range
    - iterator
    - range()
    - begin()
    - end()
    - begin_
    - end_

Class Refine
- Inheritance Relationships
  - Derived Types
- Class Documentation
  - Refine

Class Refinement
- Class Documentation
  - Refinement

Class Routing
- Class Documentation
  - Routing

Class SpinLock
- Class Documentation
  - SpinLock

Class sta
- Class Documentation
  - sta

Class StrategyFactory
- Class Documentation
  - StrategyFactory

Class StrategyPlanner
- Class Documentation
  - StrategyPlanner
    - setStrategyByString()
    - setStrategy()

Class StrategyRunner
- Class Documentation
  - StrategyRunner
    - runStrategyLoop()
    - refinementNew()

Class Tdm
- Class Documentation
  - Tdm

Class timing
- Class Documentation
  - timing

Class timingEvaluator
- Class Documentation
  - timingEvaluator

Class TimingMetricService
- Class Documentation
  - TimingMetricService

Functions¶

Function add_path_by_prev
- Function Documentation

Function aggregateHierarchyResourcesWithDistributedSlack
- Function Documentation
  - aggregateHierarchyResourcesWithDistributedSlack()

Function applyLeafResources
- Function Documentation
  - applyLeafResources()

Function calculateSmallestDelayPaths
- Function Documentation
  - calculateSmallestDelayPaths()

Function checkFixTopo
- Function Documentation
  - checkFixTopo()

Function COCP
- Function Documentation
  - COCP()

Function collectLeafResources
- Function Documentation
  - collectLeafResources()

Function compute_group_constrain
- Function Documentation
  - compute_group_constrain()

Function computeHierarchySlacks
- Function Documentation
  - computeHierarchySlacks()

Function convert_route_trees
- Function Documentation
  - convert_route_trees()

Function convertCutNetPathsToSimpleTimings
- Function Documentation
  - convertCutNetPathsToSimpleTimings()

Function convertSubConnetsToCutConnections
- Function Documentation
  - convertSubConnetsToCutConnections()

Function dijkstra_tdm
- Function Documentation
  - dijkstra_tdm()

Function dump_die_cut_result
- Function Documentation
  - dump_die_cut_result()

Function evaluatePartitionTimingComparison
- Function Documentation
  - evaluatePartitionTimingComparison()

Function floatNumEqual
- Function Documentation
  - floatNumEqual()

Function floatNumLess
- Function Documentation
  - floatNumLess()

Function formatHierarchyPath
- Function Documentation
  - formatHierarchyPath()

Function getDistributedResourceDims
- Function Documentation
  - getDistributedResourceDims()

Function getPinMinslackC
- Function Documentation
  - getPinMinslackC()

Function HSFullTiming::getSlackRange
- Function Documentation
  - getSlackRange()

Function HSFullTiming::initSlackRange
- Function Documentation
  - initSlackRange()

Function HSFullTiming::maxHopToSlackRangeEnd
- Function Documentation
  - maxHopToSlackRangeEnd()

Function HSFullTiming::maxHopToSlackRangeStart
- Function Documentation
  - maxHopToSlackRangeStart()

Function HSFullTiming::setSlackRange
- Function Documentation
  - setSlackRange()

Function HSFullTiming::slackToBucketIndex
- Function Documentation
  - slackToBucketIndex()

Function is_diff_fpga
- Function Documentation
  - is_diff_fpga()

Function lib_delay
- Function Documentation
  - lib_delay()

Function lib_max
- Function Documentation
  - lib_max()

Function lib_rmin
- Function Documentation
  - lib_rmin()

Function lib_slope
- Function Documentation
  - lib_slope()

Function multilevel
- Function Documentation
  - multilevel()

Function norm_edge
- Function Documentation
  - norm_edge()

Function output_cut_result
- Function Documentation
  - output_cut_result()

Function pack_edge
- Function Documentation
  - pack_edge()

Function partition(graph&, fpga&, vector<int>&, const PartitionParams&, int, HSFullTiming::HSPartitionFlow&)
- Function Documentation
  - partition()

Function partition(graph&, fpga&, vector<int>&, const PartitionParams&, int, flat_hash_map<string, fixInfo>&, unordered_map<string, vector<string>>&, flat_hash_map<string, int>&, HSFullTiming::HSPartitionFlow&)
- Function Documentation
  - partition()

Function partitionHierarchyGraph
- Function Documentation
  - partitionHierarchyGraph()

Function prim_mst
- Function Documentation
  - prim_mst()

Function readPartitionResult
- Function Documentation
  - readPartitionResult()

Function reform_timing_paths
- Function Documentation
  - reform_timing_paths()

Function reform_timing_paths_old
- Function Documentation
  - reform_timing_paths_old()

Function routeTrees
- Function Documentation
  - routeTrees()

Function routing
- Function Documentation
  - routing()

Function routing_flow::routingFlow
- Function Documentation
  - routingFlow()

Function saturate
- Function Documentation
  - saturate()

Function separateGraph
- Function Documentation
  - separateGraph()

Function tdm::executeTDM
- Function Documentation
  - executeTDM()

Function tdm_delay
- Function Documentation
  - tdm_delay()

Function V_Cycle
- Function Documentation
  - V_Cycle()

Function writeHierarchyPartitionArtifacts
- Function Documentation
  - writeHierarchyPartitionArtifacts()

Variables¶

Variable HSFullTiming::g_slack_range
- Variable Documentation
  - g_slack_range

Variable HSFullTiming::kDefaultSlackRange
- Variable Documentation
  - kDefaultSlackRange

Variable kMaxHierarchyResourceSlack
- Variable Documentation
  - kMaxHierarchyResourceSlack

Typedefs¶

Typedef json
- Typedef Documentation
  - json

Typedef MyPriorityQueue
- Typedef Documentation
  - MyPriorityQueue

Typedef MyPriorityQueueAllInOne
- Typedef Documentation
  - MyPriorityQueueAllInOne