Alien::Partition Class Reference

Creates tags in the matrix. More...

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

Collaboration diagram for Alien::Partition:

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.

Private Attributes
const ISpace &	m_space
	The matrix space.
const MatrixDistribution &	m_distribution
	The matrix distribution.
Arccore::UniqueArray< Arccore::String >	m_tags
	The array of tags.
Arccore::UniqueArray< Arccore::UniqueArray< Arccore::Integer > >	m_tagged_parts
	The arrays of local ids for each tag.
Arccore::UniqueArray< Arccore::Integer >	m_untagged_part

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]	distribution	The distribution of the matrix

Definition at line 40 of file Partition.cc.

References m_distribution, and m_space.

Member Function Documentation

create()

void Alien::Partition::create

(

const Arccore::UniqueArray< Arccore::String > &

tags

)

Create the tags of the matrix.

Parameters

[in]

tags

The array of tags

Definition at line 48 of file Partition.cc.

References m_distribution, m_space, m_tagged_parts, m_tags, and tag().

Referenced by ~Partition().

Here is the call graph for this function:

Here is the caller graph for this function:

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.

References m_tagged_parts.

tag()

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

inline

Get the i-th tag.

Parameters

[in]

i

The requested tag

Returns

The tag

Definition at line 76 of file Partition.h.

References m_tags.

Referenced by create().

Here is the caller graph for this function:

taggedPart()

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

inline

Get indices of a specific matching tag.

Parameters

[in]

i

The requested tag

Returns

Local ids corresponding to the tag

Definition at line 83 of file Partition.h.

References m_tagged_parts.

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.

Member Data Documentation

m_distribution

const MatrixDistribution& Alien::Partition::m_distribution

private

The matrix distribution.

Definition at line 107 of file Partition.h.

Referenced by create(), and Partition().

m_space

const ISpace& Alien::Partition::m_space

private

The matrix space.

Definition at line 105 of file Partition.h.

Referenced by create(), and Partition().

m_tagged_parts

Arccore::UniqueArray<Arccore::UniqueArray<Arccore::Integer> > Alien::Partition::m_tagged_parts

private

The arrays of local ids for each tag.

Definition at line 111 of file Partition.h.

Referenced by create(), nbTaggedParts(), and taggedPart().

m_tags

Arccore::UniqueArray<Arccore::String> Alien::Partition::m_tags

private

The array of tags.

Definition at line 109 of file Partition.h.

Referenced by create(), and tag().

m_untagged_part

Arccore::UniqueArray<Arccore::Integer> Alien::Partition::m_untagged_part

private

Definition at line 113 of file Partition.h.

---

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

• Partition.h
• Partition.cc