clang 20.0.0git
Public Member Functions | Friends | List of all members
clang::OMPNumThreadsClause Class Referencefinal

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

#include "clang/AST/OpenMPClause.h"

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

Public Member Functions

 OMPNumThreadsClause (Expr *NumThreads, Stmt *HelperNumThreads, OpenMPDirectiveKind CaptureRegion, SourceLocation StartLoc, SourceLocation LParenLoc, SourceLocation EndLoc)
 Build 'num_threads' clause with condition NumThreads.
 
 OMPNumThreadsClause ()
 Build an empty clause.
 
ExprgetNumThreads () const
 Returns number of threads.
 
- Public Member Functions inherited from clang::OMPOneStmtClause< llvm::omp::OMPC_num_threads, 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
 
- Public Member Functions inherited from clang::OMPClauseWithPreInit
const StmtgetPreInitStmt () const
 Get pre-initialization statement for the clause.
 
StmtgetPreInitStmt ()
 Get pre-initialization statement for the clause.
 
OpenMPDirectiveKind getCaptureRegion () const
 Get capture region for the stmt in the clause.
 

Friends

class OMPClauseReader
 

Additional Inherited Members

- Public Types inherited from clang::OMPOneStmtClause< llvm::omp::OMPC_num_threads, 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_num_threads, OMPClause >
static bool classof (const OMPClause *T)
 
- Static Public Member Functions inherited from clang::OMPClause
static bool classof (const OMPClause *)
 
- Static Public Member Functions inherited from clang::OMPClauseWithPreInit
static OMPClauseWithPreInitget (OMPClause *C)
 
static const OMPClauseWithPreInitget (const OMPClause *C)
 
- Protected Member Functions inherited from clang::OMPOneStmtClause< llvm::omp::OMPC_num_threads, OMPClause >
void setStmt (Stmt *S)
 
- Protected Member Functions inherited from clang::OMPClause
 OMPClause (OpenMPClauseKind K, SourceLocation StartLoc, SourceLocation EndLoc)
 
- Protected Member Functions inherited from clang::OMPClauseWithPreInit
 OMPClauseWithPreInit (const OMPClause *This)
 
void setPreInitStmt (Stmt *S, OpenMPDirectiveKind ThisRegion=llvm::omp::OMPD_unknown)
 Set pre-initialization statement for the clause.
 

Detailed Description

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

#pragma omp parallel num_threads(6)

In this example directive '#pragma omp parallel' has simple 'num_threads' clause with number of threads '6'.

Definition at line 734 of file OpenMPClause.h.

Constructor & Destructor Documentation

◆ OMPNumThreadsClause() [1/2]

clang::OMPNumThreadsClause::OMPNumThreadsClause ( Expr NumThreads,
Stmt HelperNumThreads,
OpenMPDirectiveKind  CaptureRegion,
SourceLocation  StartLoc,
SourceLocation  LParenLoc,
SourceLocation  EndLoc 
)
inline

Build 'num_threads' clause with condition NumThreads.

Parameters
NumThreadsNumber of threads for the construct.
HelperNumThreadsHelper Number of threads for the construct.
CaptureRegionInnermost OpenMP region where expressions in this clause must be captured.
StartLocStarting location of the clause.
LParenLocLocation of '('.
EndLocEnding location of the clause.

Definition at line 752 of file OpenMPClause.h.

References clang::OMPClauseWithPreInit::setPreInitStmt().

◆ OMPNumThreadsClause() [2/2]

clang::OMPNumThreadsClause::OMPNumThreadsClause ( )
inline

Build an empty clause.

Definition at line 762 of file OpenMPClause.h.

Member Function Documentation

◆ getNumThreads()

Expr * clang::OMPNumThreadsClause::getNumThreads ( ) const
inline

Returns number of threads.

Definition at line 765 of file OpenMPClause.h.

Friends And Related Function Documentation

◆ OMPClauseReader

friend class OMPClauseReader
friend

Definition at line 737 of file OpenMPClause.h.


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