Alien  1.3.0
User documentation
Loading...
Searching...
No Matches
Alien::Partition Class Reference

Creates tags in the matrix. More...

#include <core/alien/core/utils/Partition.h>

Public Member Functions

 Partition (const ISpace &space, const MatrixDistribution &distribution)
 Constructor.
 ~Partition ()=default
 Free resources.
void create (const Arccore::UniqueArray< Arccore::String > &tags)
 Create the tags of the matrix.
Arccore::Integer nbTaggedParts () const
 Get the number of untagged parts of the matrix.
Arccore::String tag (Arccore::Integer i) const
 Get the i-th tag.
const Arccore::UniqueArray< Arccore::Integer > & taggedPart (Arccore::Integer i) const
 Get indices of a specific matching tag.
bool hasUntaggedPart () const
 Whether or not the matrix has untagged part.
const Arccore::UniqueArray< Arccore::Integer > & untaggedPart () const
 Get untagged indices.

Detailed Description

Creates tags in the matrix.

Decorates the matrix by associating tags to entries

Definition at line 46 of file Partition.h.

Constructor & Destructor Documentation

◆ Partition()

Alien::Partition::Partition ( const ISpace & space,
const MatrixDistribution & distribution )

Constructor.

Parameters
[in]Space related functions.The space of the matrix
[in]distributionThe distribution of the matrix

Definition at line 40 of file Partition.cc.

Member Function Documentation

◆ create()

void Alien::Partition::create ( const Arccore::UniqueArray< Arccore::String > & tags)

Create the tags of the matrix.

Parameters
[in]tagsThe array of tags

Definition at line 48 of file Partition.cc.

References tag().

Referenced by ~Partition().

◆ hasUntaggedPart()

bool Alien::Partition::hasUntaggedPart ( ) const
inline

Whether or not the matrix has untagged part.

Returns
Whether or not the matrix has untagged part

Definition at line 92 of file Partition.h.

◆ nbTaggedParts()

Arccore::Integer Alien::Partition::nbTaggedParts ( ) const
inline

Get the number of untagged parts of the matrix.

Returns
The number of untagged parts

Definition at line 69 of file Partition.h.

◆ tag()

Arccore::String Alien::Partition::tag ( Arccore::Integer i) const
inline

Get the i-th tag.

Parameters
[in]iThe requested tag
Returns
The tag

Definition at line 76 of file Partition.h.

Referenced by create().

◆ taggedPart()

const Arccore::UniqueArray< Arccore::Integer > & Alien::Partition::taggedPart ( Arccore::Integer i) const
inline

Get indices of a specific matching tag.

Parameters
[in]iThe requested tag
Returns
Local ids corresponding to the tag

Definition at line 83 of file Partition.h.

◆ untaggedPart()

const Arccore::UniqueArray< Arccore::Integer > & Alien::Partition::untaggedPart ( ) const
inline

Get untagged indices.

Returns
Local ids of the untagged indices

Definition at line 98 of file Partition.h.


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