ompi-main/ompi/mpi/java/java/GraphComm.java
/*
 * Copyright (c) 2004-2007 The Trustees of Indiana University and Indiana
 *                         University Research and Technology
 *                         Corporation.  All rights reserved.
 * Copyright (c) 2004-2005 The University of Tennessee and The University
 *                         of Tennessee Research Foundation.  All rights
 *                         reserved.
 * Copyright (c) 2004-2005 High Performance Computing Center Stuttgart,
 *                         University of Stuttgart.  All rights reserved.
 * Copyright (c) 2004-2005 The Regents of the University of California.
 *                         All rights reserved.
 * Copyright (c) 2015      Los Alamos National Security, LLC. All rights
 *                         reserved.
 * Copyright (c) 2018      FUJITSU LIMITED.  All rights reserved.
 * Copyright (c) 2022      Cisco Systems, Inc.  All rights reserved
 * $COPYRIGHT$
 *
 * Additional copyrights may follow
 *
 * $HEADER$
 *
 *
 * This file is almost a complete re-write for Open MPI compared to the
 * original mpiJava package. Its license and copyright are listed below.
 * See <path to ompi/mpi/java/README> for more information.
 *
 *
 *  Licensed under the Apache License, Version 2.0 (the "License");
 *  you may not use this file except in compliance with the License.
 *  You may obtain a copy of the License at
 *
 *     https://www.apache.org/licenses/LICENSE-2.0
 *
 *  Unless required by applicable law or agreed to in writing, software
 *  distributed under the License is distributed on an "AS IS" BASIS,
 *  WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 *  See the License for the specific language governing permissions and
 *  limitations under the License.
 *
 *
 * File         : Graphcomm.java
 * Author       : Xinying Li
 * Created      : Thu Apr  9 12:22:15 1998
 * Revision     : $Revision: 1.5 $
 * Updated      : $Date: 2001/10/22 21:07:55 $
 * Copyright: Northeast Parallel Architectures Center
 *            at Syracuse University 1998
 */

package mpi;

/**
 * Communicator with graph structure.
 */
public final class GraphComm extends Intracomm
{
	static
	{
		init();
	}

	private static native void init();

	protected GraphComm(long handle) throws MPIException
	{
		super(handle);
	}

	protected GraphComm(long[] commRequest)
	{
		super(commRequest);
	}

	/**
	 * Duplicates this communicator.
	 * <p>Java binding of {@code MPI_COMM_DUP}.
	 * <p>It is recommended to use {@link #dup} instead of {@link #clone}
	 * because the last can't throw an {@link mpi.MPIException}.
	 * @return copy of this communicator
	 */
	@Override public GraphComm clone()
	{
		try
		{
			return dup();
		}
		catch(MPIException e)
		{
			throw new RuntimeException(e.getMessage());
		}
	}

	/**
	 * Duplicates this communicator.
	 * <p>Java binding of {@code MPI_COMM_DUP}.
	 * @return copy of this communicator
	 * @throws MPIException Signals that an MPI error of some sort has occurred.
	 */
	@Override public GraphComm dup() throws MPIException
	{
		MPI.check();
		return new GraphComm(dup(handle));
	}

	/**
	 * Duplicates this communicator.
	 * <p>The new communicator can't be used before the operation completes.
	 * The request object must be obtained calling {@link #getRequest}.
	 * <p>Java binding of {@code MPI_COMM_IDUP}.
	 * @return copy of this communicator
	 * @throws MPIException Signals that an MPI error of some sort has occurred.
	 */
	@Override public GraphComm iDup() throws MPIException
	{
		MPI.check();
		return new GraphComm(iDup(handle));
	}

	/**
	* Duplicates this communicator with the info object used in the call.
	* <p>Java binding of {@code MPI_COMM_DUP_WITH_INFO}.
	* @param info	info object to associate with the new communicator
	* @return copy of this communicator
	* @throws MPIException Signals that an MPI error of some sort has occurred.
	*/
	@Override public GraphComm dupWithInfo(Info info) throws MPIException
	{
	    MPI.check();
	    return new GraphComm(dupWithInfo(handle, info.handle));
	}

	/**
	 * Returns graph topology information.
	 * <p>Java binding of the MPI operations {@code MPI_GRAPHDIMS_GET}
	 * and {@code MPI_GRAPH_GET}.
	 * <p>The number of nodes and number of edges can be extracted
	 * from the sizes of the {@code index} and {@code edges} fields
	 * of the returned object.
	 * @return object defining node degrees and edges of graph
	 * @throws MPIException Signals that an MPI error of some sort has occurred.
	 */
	public GraphParms getDims() throws MPIException
	{
		MPI.check();
		return getDims(handle);
	}

	private native GraphParms getDims(long comm) throws MPIException;

	/**
	 * Provides adjacency information for general graph topology.
	 * <p>Java binding of the MPI operations {@code MPI_GRAPH_NEIGHBORS_COUNT}
	 * and {@code MPI_GRAPH_NEIGHBORS}.
	 * <p>The number of neighbors can be extracted from the size of the result.
	 * @param rank rank of a process in the group of this communicator
	 * @return array of ranks of neighboring processes to one specified
	 * @throws MPIException Signals that an MPI error of some sort has occurred.
	 */
	public int[] getNeighbors(int rank) throws MPIException
	{
		MPI.check();
		return getNeighbors(handle, rank);
	}

	private native int[] getNeighbors(long comm, int rank) throws MPIException;

	/**
	 * Gets the adjacency information for a distributed graph topology.
	 * @return adjacency information for a distributed graph topology
	 * @throws MPIException Signals that an MPI error of some sort has occurred.
	 */
	public DistGraphNeighbors getDistGraphNeighbors() throws MPIException
	{
		MPI.check();
		return getDistGraphNeighbors(handle);
	}

	private native DistGraphNeighbors getDistGraphNeighbors(long comm)
			throws MPIException;

	/**
	 * Compute an optimal placement.
	 * <p>Java binding of the MPI operation {@code MPI_GRAPH_MAP}.
	 * <p>The number of nodes is taken to be size of the {@code index} argument.
	 * @param index node degrees
	 * @param edges graph edges
	 * @return reordered rank of calling process
	 * @throws MPIException Signals that an MPI error of some sort has occurred.
	 */
	public int map(int[] index, int[] edges) throws MPIException
	{
		MPI.check();
		return map(handle, index, edges);
	}

	private native int map(long comm, int[] index, int[] edges) throws MPIException;

} // Graphcomm
