clang 19.0.0git
Public Member Functions | Friends | List of all members
clang::OMPCollapseClause Class Referencefinal

This represents 'collapse' clause in the '#pragma omp ...' directive. More...

#include "clang/AST/OpenMPClause.h"

Inheritance diagram for clang::OMPCollapseClause:
Inheritance graph
[legend]

Public Member Functions

 OMPCollapseClause (Expr *Num, SourceLocation StartLoc, SourceLocation LParenLoc, SourceLocation EndLoc)
 Build 'collapse' clause.
 
 OMPCollapseClause ()
 Build an empty clause.
 
ExprgetNumForLoops () const
 Return the number of associated for-loops.
 
- Public Member Functions inherited from clang::OMPOneStmtClause< llvm::omp::OMPC_collapse, OMPClause >
 OMPOneStmtClause (Stmt *S, SourceLocation StartLoc, SourceLocation LParenLoc, SourceLocation EndLoc)
 
 OMPOneStmtClause ()
 
T * getStmtAs () const
 Return the associated statement, potentially casted to T.
 
void setLParenLoc (SourceLocation Loc)
 Sets the location of '('.
 
SourceLocation getLParenLoc () const
 Returns the location of '('.
 
child_range children ()
 
const_child_range children () const
 
child_range used_children ()
 
const_child_range used_children () const
 
- Public Member Functions inherited from clang::OMPClause
SourceLocation getBeginLoc () const
 Returns the starting location of the clause.
 
SourceLocation getEndLoc () const
 Returns the ending location of the clause.
 
void setLocStart (SourceLocation Loc)
 Sets the starting location of the clause.
 
void setLocEnd (SourceLocation Loc)
 Sets the ending location of the clause.
 
OpenMPClauseKind getClauseKind () const
 Returns kind of OpenMP clause (private, shared, reduction, etc.).
 
bool isImplicit () const
 
child_range children ()
 
const_child_range children () const
 
child_range used_children ()
 Get the iterator range for the expressions used in the clauses.
 
const_child_range used_children () const
 

Friends

class OMPClauseReader
 

Additional Inherited Members

- Public Types inherited from clang::OMPOneStmtClause< llvm::omp::OMPC_collapse, OMPClause >
using child_iterator = StmtIterator
 
using const_child_iterator = ConstStmtIterator
 
using child_range = llvm::iterator_range< child_iterator >
 
using const_child_range = llvm::iterator_range< const_child_iterator >
 
- Public Types inherited from clang::OMPClause
using child_iterator = StmtIterator
 
using const_child_iterator = ConstStmtIterator
 
using child_range = llvm::iterator_range< child_iterator >
 
using const_child_range = llvm::iterator_range< const_child_iterator >
 
- Static Public Member Functions inherited from clang::OMPOneStmtClause< llvm::omp::OMPC_collapse, OMPClause >
static bool classof (const OMPClause *T)
 
- Static Public Member Functions inherited from clang::OMPClause
static bool classof (const OMPClause *)
 
- Protected Member Functions inherited from clang::OMPOneStmtClause< llvm::omp::OMPC_collapse, OMPClause >
void setStmt (Stmt *S)
 
- Protected Member Functions inherited from clang::OMPClause
 OMPClause (OpenMPClauseKind K, SourceLocation StartLoc, SourceLocation EndLoc)
 

Detailed Description

This represents 'collapse' clause in the '#pragma omp ...' directive.

#pragma omp simd collapse(3)

In this example directive '#pragma omp simd' has clause 'collapse' with single expression '3'. The parameter must be a constant positive integer expression, it specifies the number of nested loops that should be collapsed into a single iteration space.

Definition at line 976 of file OpenMPClause.h.

Constructor & Destructor Documentation

◆ OMPCollapseClause() [1/2]

clang::OMPCollapseClause::OMPCollapseClause ( Expr Num,
SourceLocation  StartLoc,
SourceLocation  LParenLoc,
SourceLocation  EndLoc 
)
inline

Build 'collapse' clause.

Parameters
NumExpression associated with this clause.
StartLocStarting location of the clause.
LParenLocLocation of '('.
EndLocEnding location of the clause.

Definition at line 990 of file OpenMPClause.h.

◆ OMPCollapseClause() [2/2]

clang::OMPCollapseClause::OMPCollapseClause ( )
inlineexplicit

Build an empty clause.

Definition at line 995 of file OpenMPClause.h.

Member Function Documentation

◆ getNumForLoops()

Expr * clang::OMPCollapseClause::getNumForLoops ( ) const
inline

Return the number of associated for-loops.

Definition at line 998 of file OpenMPClause.h.

Friends And Related Function Documentation

◆ OMPClauseReader

friend class OMPClauseReader
friend

Definition at line 978 of file OpenMPClause.h.


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