LLVM API Documentation

llvm::SCEVAddRecExpr Class Reference

#include <ScalarEvolutionExpressions.h>

Inheritance diagram for llvm::SCEVAddRecExpr:
[legend]
Collaboration diagram for llvm::SCEVAddRecExpr:
[legend]

List of all members.

Public Member Functions

const SCEV * getStart () const
const Loop * getLoop () const
const SCEV * getStepRecurrence (ScalarEvolution &SE) const
virtual bool hasComputableLoopEvolution (const Loop *QL) const
virtual bool isLoopInvariant (const Loop *QueryLoop) const
bool isAffine () const
bool isQuadratic () const
const SCEV * evaluateAtIteration (const SCEV *It, ScalarEvolution &SE) const
const SCEV * getNumIterationsInRange (ConstantRange Range, ScalarEvolution &SE) const
const SCEVAddRecExpr * getPostIncExpr (ScalarEvolution &SE) const
bool hasNoUnsignedWrap () const
void setHasNoUnsignedWrap (bool B)
bool hasNoSignedWrap () const
void setHasNoSignedWrap (bool B)
virtual void print (raw_ostream &OS) const

Static Public Member Functions

static bool classof (const SCEVAddRecExpr *S)
 Methods for support type inquiry through isa, cast, and dyn_cast:.
static bool classof (const SCEV *S)

Friends

class ScalarEvolution


Detailed Description

SCEVAddRecExpr - This node represents a polynomial recurrence on the trip count of the specified loop. This is the primary focus of the ScalarEvolution framework; all the other SCEV subclasses are mostly just supporting infrastructure to allow SCEVAddRecExpr expressions to be created and analyzed.

All operands of an AddRec are required to be loop invariant.

Definition at line 361 of file ScalarEvolutionExpressions.h.


Member Function Documentation

const SCEV* llvm::SCEVAddRecExpr::getStart (  )  const [inline]

const Loop* llvm::SCEVAddRecExpr::getLoop (  )  const [inline]

const SCEV* llvm::SCEVAddRecExpr::getStepRecurrence ( ScalarEvolution &  SE  )  const [inline]

getStepRecurrence - This method constructs and returns the recurrence indicating how much this expression steps by. If this is a polynomial of degree N, it returns a chrec of degree N-1.

Definition at line 381 of file ScalarEvolutionExpressions.h.

References llvm::ScalarEvolution::getAddRecExpr(), getLoop(), llvm::SCEVNAryExpr::getOperand(), isAffine(), llvm::SCEVNAryExpr::op_begin(), and llvm::SCEVNAryExpr::op_end().

Referenced by llvm::ScalarEvolution::getMulExpr(), getPostIncExpr(), and getSCEVStartAndStride().

virtual bool llvm::SCEVAddRecExpr::hasComputableLoopEvolution ( const Loop *  L  )  const [inline, virtual]

hasComputableLoopEvolution - Return true if this SCEV changes value in a known way in the specified loop. This property being true implies that the value is variant in the loop AND that we can emit an expression to compute the value of the expression at any particular loop iteration.

Reimplemented from llvm::SCEVNAryExpr.

Definition at line 388 of file ScalarEvolutionExpressions.h.

References L.

bool SCEVAddRecExpr::isLoopInvariant ( const Loop *  L  )  const [virtual]

isLoopInvariant - Return true if the value of this SCEV is unchanging in the specified loop.

Reimplemented from llvm::SCEVNAryExpr.

Definition at line 284 of file ScalarEvolution.cpp.

References llvm::LoopBase< BlockT, LoopT >::contains(), llvm::LoopBase< BlockT, LoopT >::getHeader(), llvm::SCEVNAryExpr::getNumOperands(), llvm::SCEVNAryExpr::getOperand(), llvm::SCEV::isLoopInvariant(), and L.

bool llvm::SCEVAddRecExpr::isAffine (  )  const [inline]

isAffine - Return true if this is an affine AddRec (i.e., it represents an expressions A+B*x where A and B are loop invariant values.

Definition at line 397 of file ScalarEvolutionExpressions.h.

References llvm::SCEVNAryExpr::getNumOperands().

Referenced by getNumIterationsInRange(), and getStepRecurrence().

bool llvm::SCEVAddRecExpr::isQuadratic (  )  const [inline]

isQuadratic - Return true if this is an quadratic AddRec (i.e., it represents an expressions A+B*x+C*x^2 where A, B and C are loop invariant values. This corresponds to an addrec of the form {L,+,M,+,N}

Definition at line 406 of file ScalarEvolutionExpressions.h.

References llvm::SCEVNAryExpr::getNumOperands().

Referenced by getNumIterationsInRange().

const SCEV * SCEVAddRecExpr::evaluateAtIteration ( const SCEV *  It,
ScalarEvolution &  SE 
) const

evaluateAtIteration - Return the value of this chain of recurrences at the specified iteration number.

evaluateAtIteration - Return the value of this chain of recurrences at the specified iteration number. We can evaluate this recurrence by multiplying each element in the chain by the binomial coefficient corresponding to it. In other words, we can evaluate {A,+,B,+,C,+,D} as:

A*BC(It, 0) + B*BC(It, 1) + C*BC(It, 2) + D*BC(It, 3)

where BC(It, k) stands for binomial coefficient.

Definition at line 687 of file ScalarEvolution.cpp.

References BinomialCoefficient(), llvm::ScalarEvolution::getAddExpr(), llvm::ScalarEvolution::getMulExpr(), llvm::SCEVNAryExpr::getNumOperands(), llvm::SCEVNAryExpr::getOperand(), getStart(), and llvm::SCEVNAryExpr::getType().

Referenced by EvaluateConstantChrecAtConstant().

const SCEV * SCEVAddRecExpr::getNumIterationsInRange ( ConstantRange  Range,
ScalarEvolution &  SE 
) const

getNumIterationsInRange - Return the number of iterations of this loop that produce values in the specified constant range. Another way of looking at this is that it returns the first iteration number where the value is not in the condition, thus computing the exit count. If the iteration count can't be computed, an instance of SCEVCouldNotCompute is returned.

getNumIterationsInRange - Return the number of iterations of this loop that produce values in the specified constant range. Another way of looking at this is that it returns the first iteration number where the value is not in the condition, thus computing the exit count. If the iteration count can't be computed, an instance of SCEVCouldNotCompute is returned.

Definition at line 4908 of file ScalarEvolution.cpp.

References llvm::ConstantRange::contains(), llvm::dyn_cast(), EvaluateConstantChrecAtConstant(), llvm::ConstantInt::get(), llvm::ScalarEvolution::getAddRecExpr(), llvm::ScalarEvolution::getConstant(), llvm::ScalarEvolution::getContext(), llvm::ScalarEvolution::getCouldNotCompute(), llvm::ConstantExpr::getICmp(), llvm::ScalarEvolution::getIntegerSCEV(), getLoop(), llvm::ConstantRange::getLower(), llvm::ScalarEvolution::getNegativeSCEV(), llvm::SCEVNAryExpr::getNumOperands(), llvm::SCEVNAryExpr::getOperand(), getStart(), llvm::SCEVNAryExpr::getType(), llvm::ScalarEvolution::getTypeSizeInBits(), llvm::ConstantRange::getUpper(), llvm::SCEVConstant::getValue(), llvm::ConstantInt::getValue(), isAffine(), llvm::ConstantRange::isFullSet(), isQuadratic(), llvm::SCEVNAryExpr::op_begin(), llvm::SCEVNAryExpr::op_end(), llvm::SCEVNAryExpr::Operands, llvm::APInt::sge(), SolveQuadraticEquation(), llvm::ConstantRange::subtract(), std::swap(), and llvm::APIntOps::udiv().

const SCEVAddRecExpr* llvm::SCEVAddRecExpr::getPostIncExpr ( ScalarEvolution &  SE  )  const [inline]

getPostIncExpr - Return an expression representing the value of this expression one iteration of the loop ahead.

Definition at line 425 of file ScalarEvolutionExpressions.h.

References llvm::ScalarEvolution::getAddExpr(), and getStepRecurrence().

bool llvm::SCEVAddRecExpr::hasNoUnsignedWrap (  )  const [inline]

Definition at line 429 of file ScalarEvolutionExpressions.h.

References llvm::SCEV::SubclassData.

void llvm::SCEVAddRecExpr::setHasNoUnsignedWrap ( bool  B  )  [inline]

Definition at line 430 of file ScalarEvolutionExpressions.h.

References llvm::SCEV::SubclassData.

bool llvm::SCEVAddRecExpr::hasNoSignedWrap (  )  const [inline]

Definition at line 433 of file ScalarEvolutionExpressions.h.

References llvm::SCEV::SubclassData.

void llvm::SCEVAddRecExpr::setHasNoSignedWrap ( bool  B  )  [inline]

Definition at line 434 of file ScalarEvolutionExpressions.h.

References llvm::SCEV::SubclassData.

void SCEVAddRecExpr::print ( raw_ostream &  OS  )  const [virtual]

print - Print out the internal representation of this scalar to the specified stream. This should really only be used for debugging purposes.

Implements llvm::SCEV.

Definition at line 303 of file ScalarEvolution.cpp.

References llvm::LoopBase< BlockT, LoopT >::getHeader(), L, and llvm::SCEVNAryExpr::Operands.

static bool llvm::SCEVAddRecExpr::classof ( const SCEVAddRecExpr *  S  )  [inline, static]

Methods for support type inquiry through isa, cast, and dyn_cast:.

Definition at line 441 of file ScalarEvolutionExpressions.h.

static bool llvm::SCEVAddRecExpr::classof ( const SCEV *  S  )  [inline, static]

Reimplemented from llvm::SCEVNAryExpr.

Definition at line 442 of file ScalarEvolutionExpressions.h.

References llvm::SCEV::getSCEVType(), and llvm::scAddRecExpr.


Friends And Related Function Documentation

friend class ScalarEvolution [friend]

Definition at line 362 of file ScalarEvolutionExpressions.h.


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