org.ejml.concurrency.EjmlConcurrency Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of ejml-core Show documentation

A fast and easy to use dense and sparse matrix linear algebra library written in Java.

There is a newer version: 0.43.1

/*
 * Copyright (c) 2021, Peter Abeles. All Rights Reserved.
 *
 * This file is part of Efficient Java Matrix Library (EJML).
 *
 * 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
 *
 *   http://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.
 */
package org.ejml.concurrency;

import org.ejml.data.Matrix;
import org.ejml.data.MatrixSparse;
import pabeles.concurrency.ConcurrencyOps;

/**
 * Central class for controlling concurrency in EJML.
 *
 * @author Peter Abeles
 */
public class EjmlConcurrency extends ConcurrencyOps {
	/** Used to toggle auto matic switching to concurrent algorithms */
	public static boolean USE_CONCURRENT = true;

	/** Minimum number of elements in a matrix before it will switch to concurrent implementation */
	public static int ELEMENT_THRESHOLD = 50_000;

	/**
	 * Sets the maximum number of threads available in the thread pool and adjusts USE_CONCURRENT. If
	 * the number of threads is less than 2 then USE_CONCURRENT will be set to false and the single thread
	 * version of code will be called. Otherwise USE_CONCURRENT will be true and the max threads in the pool
	 * set to the specified number.
	 *
	 * @param maxThreads Maximum number of threads. &le 1 means it will not be threaded.
	 */
	public static void setMaxThreads( int maxThreads ) {
		ConcurrencyOps.setMaxThreads(maxThreads);
		USE_CONCURRENT = maxThreads > 1;
	}

	public static boolean isUseConcurrent() {
		return USE_CONCURRENT;
	}

	/**
	 * Returns true if the operation on the matrix should use the concurrent implementation. If the matrix
	 * is too small it should always use a single threaded implementation since the overhead will slow it down.
	 */
	public static boolean useConcurrent( MatrixSparse mat ) {
		if (!USE_CONCURRENT)
			return false;

		return mat.getNonZeroLength() > ELEMENT_THRESHOLD;
	}

	/**
	 * Returns true if the operation on the matrix should use the concurrent implementation. If the matrix
	 * is too small it should always use a single threaded implementation since the overhead will slow it down.
	 */
	public static boolean useConcurrent( Matrix mat ) {
		if (!USE_CONCURRENT)
			return false;

		return mat.getNumRows()*mat.getNumCols() > ELEMENT_THRESHOLD;
	}
}