User_function
Date: 2014-05-09

mpi

## Class User_function

- java.lang.Object
- - mpi.User_function

-     public abstract class User_function
      extends java.lang.Object

- - ### Constructor Summary

    Constructors
    Constructor and Description
    `User_function()`

  - ### Method Summary

    Methods
    Modifier and Type | Method and Description
    --- | ---
    `abstract void` | `Call(java.lang.Object invec, int inoffset, java.lang.Object inoutvec, int inoutoffset, int count, Datatype datatype)` User-defined function for a new `Op`.

    - ### Methods inherited from class java.lang.Object

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

- - ### Constructor Detail

    - #### User_function

          public User_function()

  - ### Method Detail

    - #### Call

          public abstract void Call(java.lang.Object invec,
                  int inoffset,
                  java.lang.Object inoutvec,
                  int inoutoffset,
                  int count,
                  Datatype datatype)
                             throws MPIException

      User-defined function for a new `Op`.

      `invec` | array of values to combine with `inoutvec` elements
      `inoffset` | initial offset in `invec```
      `inoutvec` | in-out array of accumulator locations
      `inoutoffset` | initial offset in `inoutvec```
      `count` | number of items in arrays
      `datatype` | type of each item

      Java equivalent of the MPI `USER_FUNCTION`.

      Throws:
        `MPIException`