jcublas.cublasSideMode Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of nd4j-jcublas-common Show documentation
There is a newer version: 0.4-rc3.7
/*
 * JCublas - Java bindings for CUBLAS, the NVIDIA CUDA BLAS library,
 * to be used with JCuda
 *
 * Copyright (c) 2010-2012 Marco Hutter - http://www.jcuda.org
 *
 * Permission is hereby granted, free of charge, to any person
 * obtaining a copy of this software and associated documentation
 * files (the "Software"), to deal in the Software without
 * restriction, including without limitation the rights to use,
 * copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the
 * Software is furnished to do so, subject to the following
 * conditions:
 *
 * The above copyright notice and this permission notice shall be
 * included in all copies or substantial portions of the Software.
 *
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND,
 * EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES
 * OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND
 * NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT
 * HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY,
 * WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
 * FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR
 * OTHER DEALINGS IN THE SOFTWARE.
 */
package jcublas;

/**
 * Indicates whether the dense matrix is on the left or right side
 * in the matrix equation solved by a particular function.
 */
public class cublasSideMode {
    /**
     * The matrix is on the left side in the equation
     */
    public static final int CUBLAS_SIDE_LEFT = 0;

    /**
     * The matrix is on the right side in the equation
     */
    public static final int CUBLAS_SIDE_RIGHT = 1;

    /**
     * Private constructor to prevent instantiation
     */
    private cublasSideMode() {
    }

    /**
     * Returns a string representation of the given constant
     *
     * @return A string representation of the given constant
     */
    public static String stringFor(int n) {
        switch (n) {
            case CUBLAS_SIDE_LEFT:
                return "CUBLAS_SIDE_LEFT";
            case CUBLAS_SIDE_RIGHT:
                return "CUBLAS_SIDE_RIGHT";
        }
        return "INVALID cublasSideMode: " + n;
    }
}