clang 24.0.0git
OMPNumTeamsClause Class Referencefinal

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

#include "clang/AST/OpenMPClause.h"

Inheritance diagram for OMPNumTeamsClause:
[legend]

Public Member Functions

ArrayRef< Expr * > getNumTeams ()
 Return NumTeams expressions.
ArrayRef< Expr * > getNumTeams () const
 Return NumTeams expressions.
OpenMPNumTeamsClauseModifier getModifier () const
 Get the modifier.
const Expr * getModifierExpr () const
 Get the expression of the modifier.
Expr * getModifierExpr ()
 Get the expression of the modifier.
const Expr * getDimsModifierExpr () const
 Get the expression of the modifier if it is the dims modifier.
SourceLocation getModifierLoc () const
 Get the location of the modifier.
child_range children ()
const_child_range children () const
child_range used_children ()
const_child_range used_children () const

Static Public Member Functions

static OMPNumTeamsClauseCreate (const ASTContext &C, OpenMPDirectiveKind CaptureRegion, SourceLocation StartLoc, SourceLocation LParenLoc, SourceLocation EndLoc, ArrayRef< Expr * > VL, OpenMPNumTeamsClauseModifier Modifier, Expr *ModifierExpr, SourceLocation ModifierLoc, Stmt *PreInit)
 Creates clause with a list of variables VL.
static OMPNumTeamsClauseCreateEmpty (const ASTContext &C, unsigned N)
 Creates an empty clause with N variables.
static bool classof (const OMPClause *T)

Friends

class OMPClauseReader

Detailed Description

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

#pragma omp teams num_teams(n)

In this example directive '#pragma omp teams' has clause 'num_teams' with single expression 'n'.

#pragma omp teams num_teams(m:n)

In this example directive '#pragma omp teams' has clause 'num_teams' with single expression 'n' as upper-bound and modifier expression 'm' as lower-bound.

#pragma omp teams num_teams(dims(2): x, y)

In this example directive '#pragma omp teams' has clause 'num_teams' with the 'dims' modifier specifying two dimensions. The list specifies the number of teams in each dimension.

When 'ompx_bare' clause exists on a 'target' directive, 'num_teams' clause can accept up to three expressions.

#pragma omp target teams ompx_bare num_teams(x, y, z)

Definition at line 7006 of file OpenMPClause.h.

Member Function Documentation

◆ children() [1/2]

child_range OMPNumTeamsClause::children ( )
inline

Definition at line 7093 of file OpenMPClause.h.

Referenced by children().

◆ children() [2/2]

const_child_range OMPNumTeamsClause::children ( ) const
inline

Definition at line 7098 of file OpenMPClause.h.

References children().

◆ classof()

bool OMPNumTeamsClause::classof ( const OMPClause * T)
inlinestatic

Definition at line 7109 of file OpenMPClause.h.

◆ Create()

OMPNumTeamsClause * OMPNumTeamsClause::Create ( const ASTContext & C,
OpenMPDirectiveKind CaptureRegion,
SourceLocation StartLoc,
SourceLocation LParenLoc,
SourceLocation EndLoc,
ArrayRef< Expr * > VL,
OpenMPNumTeamsClauseModifier Modifier,
Expr * ModifierExpr,
SourceLocation ModifierLoc,
Stmt * PreInit )
static

Creates clause with a list of variables VL.

Parameters
CAST context.
StartLocStarting location of the clause.
LParenLocLocation of '('.
EndLocEnding location of the clause.
VLList of references to the variables.
ModifierThe modifier specified in the clause.
ModifierExprThe expression of the modifier.
ModifierLocLocation of the modifier.
PreInit

Definition at line 1944 of file OpenMPClause.cpp.

References clang::C.

Referenced by clang::SemaOpenMP::ActOnOpenMPNumTeamsClause().

◆ CreateEmpty()

OMPNumTeamsClause * OMPNumTeamsClause::CreateEmpty ( const ASTContext & C,
unsigned N )
static

Creates an empty clause with N variables.

Parameters
CAST context.
NThe number of variables.

Definition at line 1961 of file OpenMPClause.cpp.

References clang::C.

Referenced by clang::OMPClauseReader::readClause().

◆ getDimsModifierExpr()

const Expr * OMPNumTeamsClause::getDimsModifierExpr ( ) const
inline

Get the expression of the modifier if it is the dims modifier.

Definition at line 7084 of file OpenMPClause.h.

References getModifierExpr().

◆ getModifier()

OpenMPNumTeamsClauseModifier OMPNumTeamsClause::getModifier ( ) const
inline

Get the modifier.

Definition at line 7075 of file OpenMPClause.h.

◆ getModifierExpr() [1/2]

Expr * OMPNumTeamsClause::getModifierExpr ( )
inline

Get the expression of the modifier.

Definition at line 7081 of file OpenMPClause.h.

◆ getModifierExpr() [2/2]

const Expr * OMPNumTeamsClause::getModifierExpr ( ) const
inline

Get the expression of the modifier.

Definition at line 7078 of file OpenMPClause.h.

Referenced by getDimsModifierExpr().

◆ getModifierLoc()

SourceLocation OMPNumTeamsClause::getModifierLoc ( ) const
inline

Get the location of the modifier.

Definition at line 7091 of file OpenMPClause.h.

◆ getNumTeams() [1/2]

ArrayRef< Expr * > OMPNumTeamsClause::getNumTeams ( )
inline

Return NumTeams expressions.

Definition at line 7067 of file OpenMPClause.h.

Referenced by getNumTeams().

◆ getNumTeams() [2/2]

ArrayRef< Expr * > OMPNumTeamsClause::getNumTeams ( ) const
inline

Return NumTeams expressions.

Definition at line 7070 of file OpenMPClause.h.

References getNumTeams().

◆ used_children() [1/2]

child_range OMPNumTeamsClause::used_children ( )
inline

Definition at line 7102 of file OpenMPClause.h.

◆ used_children() [2/2]

const_child_range OMPNumTeamsClause::used_children ( ) const
inline

Definition at line 7105 of file OpenMPClause.h.

◆ OMPClauseReader

friend class OMPClauseReader
friend

Definition at line 7010 of file OpenMPClause.h.

References OMPClauseReader.

Referenced by OMPClauseReader.


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