mpi

Class Win

java.lang.Object

mpi.Win

All Implemented Interfaces:

Freeable

public final class Win
extends java.lang.Object
implements Freeable

This class represents MPI_Win.

Constructor Summary

Constructors

Constructor and Description
Win(java.nio.Buffer base, int size, int dispUnit, Info info, Comm comm) Java binding of MPI_WIN_CREATE.

Method Summary

Modifier and Type	Method and Description
void	accumulate(java.nio.Buffer origin, int orgCount, Datatype orgType, int targetRank, int targetDisp, int targetCount, Datatype targetType, Op op) Java binding of MPI_ACCUMULATE.
void	callErrhandler(int errorCode) Java binding of the MPI operation MPI_WIN_CALL_ERRHANDLER.
void	complete() Java binding of the MPI operation MPI_WIN_COMPLETE.
static int	createKeyval() Create a new attribute key.
void	deleteAttr(int keyval) Deletes an attribute value associated with a key.
void	fence(int assertion) Java binding of MPI_WIN_FENCE.
void	free() Java binding of MPI_WIN_FREE.
static void	freeKeyval(int keyval) Frees an attribute key.
void	get(java.nio.Buffer origin, int orgCount, Datatype orgType, int targetRank, int targetDisp, int targetCount, Datatype targetType) Java binding of MPI_GET.
java.lang.Object	getAttr(int keyval) Retrieves attribute value by key.
Group	getGroup() Java binding of the MPI operation MPI_GET_GROUP.
void	lock(int lockType, int rank, int assertion) Java binding of the MPI operation MPI_WIN_LOCK.
void	post(Group group, int assertion) Java binding of the MPI operation MPI_WIN_POST.
void	put(java.nio.Buffer origin, int orgCount, Datatype orgType, int targetRank, int targetDisp, int targetCount, Datatype targetType) Java binding of MPI_PUT.
void	setAttr(int keyval, java.lang.Object value) Stores attribute value associated with a key.
void	setErrhandler(Errhandler errhandler) Java binding of the MPI operation MPI_WIN_SET_ERRHANDLER.
void	start(Group group, int assertion) Java binding of the MPI operation MPI_WIN_START.
boolean	test() Java binding of the MPI operation MPI_WIN_TEST.
void	unlock(int rank) Java binding of the MPI operation MPI_WIN_UNLOCK.
void	waitFor() Java binding of the MPI operation MPI_WIN_WAIT.

Methods inherited from class java.lang.Object

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

Constructor Detail

Win

public Win(java.nio.Buffer base,
           int size,
           int dispUnit,
           Info info,
           Comm comm)
    throws MPIException

Java binding of MPI_WIN_CREATE.

Parameters:

base - initial address of window

size - size of window (buffer elements)

dispUnit - local unit size for displacements (buffer elements)

info - info object

comm - communicator

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

Method Detail

getGroup

public Group getGroup()
               throws MPIException

Java binding of the MPI operation MPI_GET_GROUP.

Returns:

group of processes which share access to the window

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

put

public void put(java.nio.Buffer origin,
                int orgCount,
                Datatype orgType,
                int targetRank,
                int targetDisp,
                int targetCount,
                Datatype targetType)
         throws MPIException

Java binding of MPI_PUT.

Parameters:

origin - origin buffer

orgCount - number of entries in origin buffer

orgType - datatype of each entry in origin buffer

targetRank - rank of target

targetDisp - displacement from start of window to target buffer

targetCount - number of entries in target buffer

targetType - datatype of each entry in target buffer

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

get

public void get(java.nio.Buffer origin,
                int orgCount,
                Datatype orgType,
                int targetRank,
                int targetDisp,
                int targetCount,
                Datatype targetType)
         throws MPIException

Java binding of MPI_GET.

Parameters:

origin - origin buffer

orgCount - number of entries in origin buffer

orgType - datatype of each entry in origin buffer

targetRank - rank of target

targetDisp - displacement from start of window to target buffer

targetCount - number of entries in target buffer

targetType - datatype of each entry in target buffer

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

accumulate

public void accumulate(java.nio.Buffer origin,
                       int orgCount,
                       Datatype orgType,
                       int targetRank,
                       int targetDisp,
                       int targetCount,
                       Datatype targetType,
                       Op op)
                throws MPIException

Java binding of MPI_ACCUMULATE.

Parameters:

origin - origin buffer

orgCount - number of entries in origin buffer

orgType - datatype of each entry in origin buffer

targetRank - rank of target

targetDisp - displacement from start of window to target buffer

targetCount - number of entries in target buffer

targetType - datatype of each entry in target buffer

op - reduce operation

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

fence

public void fence(int assertion)
           throws MPIException

Java binding of MPI_WIN_FENCE.

Parameters:

assertion - program assertion

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

start

public void start(Group group,
                  int assertion)
           throws MPIException

Java binding of the MPI operation MPI_WIN_START.

Parameters:

group - group of target processes

assertion - program assertion

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

complete

public void complete()
              throws MPIException

Java binding of the MPI operation MPI_WIN_COMPLETE.

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

post

public void post(Group group,
                 int assertion)
          throws MPIException

Java binding of the MPI operation MPI_WIN_POST.

Parameters:

group - group of origin processes

assertion - program assertion

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

waitFor

public void waitFor()
             throws MPIException

Java binding of the MPI operation MPI_WIN_WAIT.

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

test

public boolean test()
             throws MPIException

Java binding of the MPI operation MPI_WIN_TEST.

Returns:

true if success

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

lock

public void lock(int lockType,
                 int rank,
                 int assertion)
          throws MPIException

Java binding of the MPI operation MPI_WIN_LOCK.

Parameters:

lockType - either MPI.LOCK_EXCLUSIVE or MPI.LOCK_SHARED

rank - rank of locked window

assertion - program assertion

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

unlock

public void unlock(int rank)
            throws MPIException

Java binding of the MPI operation MPI_WIN_UNLOCK.

Parameters:

rank - rank of window

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

setErrhandler

public void setErrhandler(Errhandler errhandler)
                   throws MPIException

Java binding of the MPI operation MPI_WIN_SET_ERRHANDLER.

Parameters:

errhandler - new MPI error handler for window

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

callErrhandler

public void callErrhandler(int errorCode)
                    throws MPIException

Java binding of the MPI operation MPI_WIN_CALL_ERRHANDLER.

Parameters:

errorCode - error code

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

createKeyval

public static int createKeyval()
                        throws MPIException

Create a new attribute key.

Java binding of the MPI operation MPI_WIN_CREATE_KEYVAL.

Returns:

attribute key for future access

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

freeKeyval

public static void freeKeyval(int keyval)
                       throws MPIException

Frees an attribute key.

Java binding of the MPI operation MPI_WIN_FREE_KEYVAL.

Parameters:

keyval - attribute key

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

setAttr

public void setAttr(int keyval,
                    java.lang.Object value)
             throws MPIException

Stores attribute value associated with a key.

Java binding of the MPI operation MPI_WIN_SET_ATTR.

Parameters:

keyval - attribute key

value - attribute value

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

getAttr

public java.lang.Object getAttr(int keyval)
                         throws MPIException

Retrieves attribute value by key.

Java binding of the MPI operation MPI_WIN_GET_ATTR.

Parameters:

keyval - attribute key

Returns:

attribute value or null if no attribute is associated with the key.

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

deleteAttr

public void deleteAttr(int keyval)
                throws MPIException

Deletes an attribute value associated with a key.

Java binding of the MPI operation MPI_WIN_DELETE_ATTR.

Parameters:

keyval - attribute key

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.

free

public void free()
          throws MPIException

Java binding of MPI_WIN_FREE.

Specified by:

free in interface Freeable

Throws:

MPIException - Signals that an MPI exception of some sort has occurred.