SageInterface::CheckedCanonicalLoopPlan

Immutable, fully checked description of one transformable C/C++ loop.

Synopsis

Declared in <SageIII/sageInterface/sageInterface.h>

class CheckedCanonicalLoopPlan;

Member Functions

Name	Description
CheckedCanonicalLoopPlan [constructor] [deleted]	Constructors
operator= [deleted]	Assignment operators
body
forInit
hasInclusiveBound
incrementExpression
induction
inductionIsUnsigned
inductionSymbol
inductionType
inductionWidth
initializer
initializerIsDeclaration
isIncreasing
loop
lowerBound
stride
structuralOwner
testExpression
testStatement
upperBound

Private Member Functions

Name

CheckedCanonicalLoopPlan [constructor]

Private Data Members

Name

body_

for_init_

inclusive_

increasing_

increment_expression_

induction_

induction_is_unsigned_

induction_symbol_

induction_type_

induction_width_

initializer_

initializer_is_declaration_

loop_

lower_bound_

stride_

structural_owner_

test_expression_

test_statement_

upper_bound_

Friends

Name	Description
SageInterface::requireCheckedCanonicalLoopPlan	Build a checked loop plan without modifying or allocating into the AST.

Non-Member Functions

Name	Description
exactCanonicalLoopTripCount	Return an exact constant trip count when both bounds are exact integer constants in the induction type's domain and the terminal increment cannot overflow or wrap. Dynamic bounds, an unsafe terminal increment, and an unrepresentable count return nullopt; a consumer requiring a constant count must reject nullopt.

Description

Construction validates exact reciprocal ownership for every header/body edge, an acyclic structural owner chain, a side‐effect‐free and loop‐ invariant bound/stride surface, a positive nonzero constant stride magnitude, and the absence of induction‐variable mutation or escape from the body. Every reference is a borrowed snapshot; transformation commits revalidate the snapshot before changing the AST. Only the checked factory can construct a plan.

Created with MrDocs