mpi

Class Group

java.lang.Object

mpi.Group

public class Group
extends java.lang.Object

This class represents MPI_Group.

Constructor Summary

Constructors

Constructor and Description
Group(int type)

Method Summary

Modifier and Type	Method and Description
static int	compare(Group group1, Group group2) Compare two groups.
static Group	difference(Group group1, Group group2) Result contains all elements of the first group that are not in the second group.
Group	excl(int[] ranks) Create a subset group excluding specified processes.
void	free() Destructor.
int	getRank() Rank of this process in group.
int	getSize() Size of group.
Group	incl(int[] ranks) Create a subset group including specified processes.
static Group	intersection(Group group1, Group group2) Set intersection of two groups.
Group	rangeExcl(int[][] ranges) Create a subset group excluding processes specified by strided intervals of ranks.
Group	rangeIncl(int[][] ranges) Create a subset group including processes specified by strided intervals of ranks.
static int[]	translateRanks(Group group1, int[] ranks1, Group group2) Translate ranks within one group to ranks within another.
static Group	union(Group group1, Group group2) Set union of two groups.

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

Group

public Group(int type)

Method Detail

translateRanks

public static int[] translateRanks(Group group1,
                                   int[] ranks1,
                                   Group group2)
                            throws MPIException

Translate ranks within one group to ranks within another.

Parameters:

group1 - first group.

ranks1 - array of valid ranks in group1.

group2 - second group.

Returns:

array of corresponding ranks in group2

Java binding of the MPI operation MPI_GROUP_TRANSLATE_RANKS.

Result elements are MPI.UNDEFINED where no correspondence exists.

Throws:

MPIException - Points out that an MPI exception has occured.

compare

public static int compare(Group group1,
                          Group group2)
                   throws MPIException

Compare two groups.

Parameters:

group1 - first group.

group2 - second group.

Returns:

result.

Java binding of the MPI operation MPI_GROUP_COMPARE.

MPI.IDENT results if the group members and group order are exactly the same in both groups. MPI.SIMILAR results if the group members are the same but the order is different. MPI.UNEQUAL results otherwise.

Throws:

MPIException - Points out that an MPI exception has occured.

union

public static Group union(Group group1,
                          Group group2)
                   throws MPIException

Set union of two groups.

Parameters:

group1 - first group.

group2 - second group.

Returns:

union group.

Java binding of the MPI operation MPI_GROUP_UNION.

Throws:

MPIException - Points out that an MPI exception has occured.

intersection

public static Group intersection(Group group1,
                                 Group group2)
                          throws MPIException

Set intersection of two groups.

Parameters:

group1 - first group.

group2 - second group.

Returns:

intersection group.

Java binding of the MPI operation MPI_GROUP_INTERSECTION.

Throws:

MPIException - Points out that an MPI exception has occured.

difference

public static Group difference(Group group1,
                               Group group2)
                        throws MPIException

Result contains all elements of the first group that are not in the second group.

Parameters:

group1 - first group.

group2 - second group.

Returns:

difference group.

Java binding of the MPI operation MPI_GROUP_DIFFERENCE.

Throws:

MPIException - Points out that an MPI exception has occured.

getSize

public int getSize()
            throws MPIException

Size of group.

Returns:

number of processors in the group.

Java binding of the MPI operation MPI_GROUP_SIZE.

Throws:

MPIException - Points out that an MPI exception has occured.

getRank

public int getRank()
            throws MPIException

Rank of this process in group.

Returns:

rank of the calling process in the group.

Java binding of the MPI operation MPI_GROUP_RANK.

Result value is MPI.UNDEFINED if this process is not a member of the group.

Throws:

MPIException - Points out that an MPI exception has occured.

incl

public Group incl(int[] ranks)
           throws MPIException

Create a subset group including specified processes.

Parameters:

ranks - ranks from this group to appear in new group.

Returns:

new group.

Java binding of the MPI operation MPI_GROUP_INCL.

Throws:

MPIException - Points out that an MPI exception has occured.

excl

public Group excl(int[] ranks)
           throws MPIException

Create a subset group excluding specified processes.

Parameters:

ranks - ranks from thsi groupnot to appear in new group.

Returns:

new group.

Java binding of the MPI operation MPI_GROUP_EXCL.

Throws:

MPIException - Points out that an MPI exception has occured.

rangeIncl

public Group rangeIncl(int[][] ranges)
                throws MPIException

Create a subset group including processes specified by strided intervals of ranks.

Parameters:

ranges - array of integer triplets.

Returns:

new group.

Java binding of the MPI operation MPI_GROUP_RANGE_INCL.

The triplets are of the form (first rank, last rank, stride) indicating ranks in this group to be included in the new group. The size of the first dimension of ranges is the number of triplets. The size of the second dimension is 3.

Throws:

MPIException - Points out that an MPI exception has occured.

rangeExcl

public Group rangeExcl(int[][] ranges)
                throws MPIException

Create a subset group excluding processes specified by strided intervals of ranks.

Parameters:

ranges - array of integer triplets.

Returns:

new group.

Java binding of the MPI operation MPI_GROUP_RANGE_EXCL.

Triplet array is defined as for Range_incl, the ranges indicating ranks in this group to be excluded from the new group.

Throws:

MPIException - Points out that an MPI exception has occured.

free

public void free()

Destructor.

Java binding of the MPI operation MPI_GROUP_FREE.