• Home
• org.mariuszgromada.math
• MathParser.org-mXparser
• 4.4.3
• source code
• PrimesCache.java

×

Project download

Many resources are needed to download a project. Please understand that we have to compensate our server costs. Thank you in advance.
Project price only 1 $

You can buy this project and download/modify it how often you want.

org.mariuszgromada.math.mxparser.mathcollection.PrimesCache Maven / Gradle / Ivy

/*
 * @(#)PrimesCache.java        4.4.3    2022-05-28
 *
 * MathParser.org-mXparser DUAL LICENSE AGREEMENT as of date 2022-05-22
 * The most up-to-date license is available at the below link:
 * - https://mathparser.org/mxparser-license
 *
 * AUTHOR: Copyright 2010 - 2022 Mariusz Gromada - All rights reserved
 * PUBLISHER: INFIMA - https://payhip.com/infima
 *
 * SOFTWARE means source code and/or binary form and/or documentation.
 * PRODUCT: MathParser.org-mXparser SOFTWARE
 * LICENSE: DUAL LICENSE AGREEMENT
 *
 * BY INSTALLING, COPYING, OR OTHERWISE USING THE PRODUCT, YOU AGREE TO BE
 * BOUND BY ALL OF THE TERMS AND CONDITIONS OF THE DUAL LICENSE AGREEMENT.
 *
 * AUTHOR & PUBLISHER provide the PRODUCT under the DUAL LICENSE AGREEMENT
 * model designed to meet the needs of both non-commercial use as well as
 * commercial use.
 *
 * NON-COMMERCIAL USE means any use or activity where a fee is not charged
 * and the purpose is not the sale of a good or service, and the use or
 * activity is not intended to produce a profit. NON-COMMERCIAL USE examples:
 *
 * 1. Free Open-Source Software ("FOSS").
 * 2. Non-commercial use in research, scholarly and education.
 *
 * COMMERCIAL USE means any use or activity where a fee is charged or the
 * purpose is the sale of a good or service, or the use or activity is
 * intended to produce a profit. COMMERCIAL USE examples:
 *
 * 1. OEMs (Original Equipment Manufacturers).
 * 2. ISVs (Independent Software Vendors).
 * 3. VARs (Value Added Resellers).
 * 4. Other distributors that combine and distribute commercially licensed
 *    software.
 *
 * IN CASE YOU WANT TO USE THE PRODUCT COMMERCIALLY, YOU MUST PURCHASE THE
 * APPROPRIATE LICENSE FROM "INFIMA" ONLINE STORE, STORE ADDRESS:
 *
 * 1. https://mathparser.org/order-commercial-license
 * 2. https://payhip.com/infima
 *
 * NON-COMMERCIAL LICENSE
 *
 * Redistribution and use of the PRODUCT in source and/or binary forms,
 * with or without modification, are permitted provided that the following
 * conditions are met:
 *
 * 1. Redistributions of source code must retain unmodified content of the
 *    entire MathParser.org-mXparser DUAL LICENSE AGREEMENT, including
 *    definition of NON-COMMERCIAL USE, definition of COMMERCIAL USE,
 *    NON-COMMERCIAL LICENSE conditions, COMMERCIAL LICENSE conditions, and
 *    the following DISCLAIMER.
 * 2. Redistributions in binary form must reproduce the entire content of
 *    MathParser.org-mXparser DUAL LICENSE AGREEMENT in the documentation
 *    and/or other materials provided with the distribution, including
 *    definition of NON-COMMERCIAL USE, definition of COMMERCIAL USE,
 *    NON-COMMERCIAL LICENSE conditions, COMMERCIAL LICENSE conditions, and
 *    the following DISCLAIMER.
 *
 * COMMERCIAL LICENSE
 *
 *  1. Before purchasing a commercial license, AUTHOR & PUBLISHER allow you
 *     to download, install and use up to three copies of the PRODUCT to
 *     perform integration tests, confirm the quality of the PRODUCT and
 *     its suitability. The testing period should be limited to fourteen
 *     days. Tests should be performed under the conditions of test
 *     environments. The purpose of the tests must not be to generate profit.
 *  2. Provided that you purchased a license from "INFIMA" online store
 *     (store address: https://mathparser.org/order-commercial-license or
 *     https://payhip.com/infima), and you comply with all below terms and
 *     conditions, and you have acknowledged and understood the following
 *     DISCLAIMER, AUTHOR & PUBLISHER grant you a nonexclusive license
 *     including the following rights:
 *  3. The license has been granted only to you, i.e., the person or entity
 *     that made the purchase, who is identified and confirmed by the data
 *     provided during the purchase.
 *  4. In case you purchased a license in the "ONE-TIME PURCHASE" model,
 *     the license has been granted only for the PRODUCT version specified
 *     in the purchase. The upgrade policy gives you additional rights and
 *     is described in the dedicated section below.
 *  5. In case you purchased a license in the "SUBSCRIPTION" model, you can
 *     install and use any version of the PRODUCT, but only during the
 *     subscription validity period.
 *  6. In case you purchased a "SINGLE LICENSE" you can install and use the
 *     PRODUCT from one workstation.
 *  7. Additional copies of the PRODUCT can be installed and used from more
 *     than one workstation; however, this number is limited to the number
 *     of workstations purchased as per order.
 *  8. In case you purchased a "SITE LICENSE ", the PRODUCT can be installed
 *     and used from all workstations located at your premises.
 *  9. You may incorporate the unmodified PRODUCT into your own products
 *     and software.
 * 10. If you purchased a license with the "SOURCE CODE" option, you may
 *     modify the PRODUCT's source code and incorporate the modified source
 *     code into your own products and/or software.
 * 11. Provided that the license validity period has not expired, you may
 *     distribute your product and/or software with the incorporated
 *     PRODUCT royalty-free.
 * 12. You may make copies of the PRODUCT for backup and archival purposes.
 * 13. AUTHOR & PUBLISHER reserve all rights not expressly granted to you
 *     in this agreement.
 *
 * ADDITIONAL CLARIFICATION ON WORKSTATION
 *
 * A workstation is a device, a remote device, or a virtual device, used by
 * you, your employees, or other entities to whom you have commissioned the
 * tasks. For example, the number of workstations may refer to the number
 * of software developers, engineers, architects, scientists, and other
 * professionals who use the PRODUCT on your behalf. The number of
 * workstations is not the number of copies of your end-product that you
 * distribute to your end-users.
 *
 * By purchasing the COMMERCIAL LICENSE, you only pay for the number of
 * workstations, while the number of copies of your final product
 * (delivered to your end-users) is not limited.
 *
 * UPGRADE POLICY
 *
 * The PRODUCT is versioned according to the following convention:
 *
 *    [MAJOR].[MINOR].[PATCH]
 *
 * 1. COMMERCIAL LICENSE holders can install and use the updated version
 *    for bug fixes free of charge, i.e. if you have purchased a license
 *    for the [MAJOR].[MINOR] version (e.g.: 5.0), you can freely install
 *    all the various releases specified in the [PATCH] version (e.g.: 5.0.2).
 *    The license terms remain unchanged after the update.
 * 2. COMMERCIAL LICENSE holders for [MAJOR].[MINOR] version (e.g.: 5.0)
 *    can install and use the updated version [MAJOR].[MINOR + 1] free of
 *    charge, i.e., plus one release in the [MINOR] range (e.g.: 5.1). The
 *    license terms remain unchanged after the update.
 * 3. COMMERCIAL LICENSE holders who wish to upgrade their version, but are
 *    not eligible for the free upgrade, can claim a discount when
 *    purchasing the upgrade. For this purpose, please contact us via e-mail.
 *
 * DISCLAIMER
 *
 * THIS PRODUCT IS PROVIDED BY AUTHOR & PUBLISHER "AS IS" AND ANY EXPRESS
 * OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE IMPLIED
 * WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
 * DISCLAIMED. IN NO EVENT SHALL AUTHOR OR PUBLISHER OR CONTRIBUTORS BE
 * LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR
 * CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF
 * SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS
 * INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN
 * CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE)
 * ARISING IN ANY WAY OUT OF THE USE OF THIS PRODUCT, EVEN IF ADVISED OF
 * THE POSSIBILITY OF SUCH DAMAGE.
 *
 * THE VIEWS AND CONCLUSIONS CONTAINED IN THE PRODUCT AND DOCUMENTATION ARE
 * THOSE OF THE AUTHORS AND SHOULD NOT BE INTERPRETED AS REPRESENTING
 * OFFICIAL POLICIES, EITHER EXPRESSED OR IMPLIED, OF AUTHOR OR PUBLISHER.
 *
 * CONTACT
 *
 * - e-mail: [email protected]
 * - website: https://mathparser.org
 * - source code: https://github.com/mariuszgromada/MathParser.org-mXparser
 * - online store: https://mathparser.org/order-commercial-license
 * - online store: https://payhip.com/infima
 */
package org.mariuszgromada.math.mxparser.mathcollection;

import org.mariuszgromada.math.mxparser.mXparser;

/**
 * Class for generating prime numbers cache using
 * Eratosthenes Sieve.
 *
 * @author         Mariusz Gromada

 *                 [email protected]

 *                 MathSpace.pl

 *                 MathParser.org - mXparser project page

 *                 mXparser on GitHub

 *                 mXparser on SourceForge

 *                 mXparser on Bitbucket

 *                 mXparser on CodePlex

 *                 Janet Sudoku - project web page

 *                 Janet Sudoku on GitHub

 *                 Janet Sudoku on CodePlex

 *                 Janet Sudoku on SourceForge

 *                 Janet Sudoku on BitBucket

 *                 Scalar Free

 *                 Scalar Pro

 *                 ScalarMath.org

 *
 * @version        4.4.2
 */
public class PrimesCache {
	/**
	 * Default range of integer to store in cache
	 */
	public static final int DEFAULT_MAX_NUM_IN_CACHE = 10000000;
	/**
	 * Empty cache status
	 */
	public static final boolean CACHE_EMPTY = false;
	/**
	 * Cache ready to use
	 */
	public static final boolean CACHING_FINISHED = true;
	/**
	 * Indicator if given number is a prime
	 */
	public static final int IS_PRIME = 1;
	/**
	 * Indicator if given number is not a prime
	 */
	public static final int IS_NOT_PRIME = 0;
	/**
	 * Indicator that the value is not stored
	 * in cache
	 */
	public static final int NOT_IN_CACHE = -1;
	/**
	 * Primes between 0 ... and ... maximumNumberInCache
	 * will be cached
	 */
	int maxNumInCache;
	/**
	 * Number of cached prime numbers
	 */
	int numberOfPrimes;
	/**
	 * Time in seconds showing
	 * how long did it take to finalize prime numbers
	 * caching.
	 */
	double computingTime;
	/**
	 * Caching process status
	 */
	boolean cacheStatus;
	/**
	 * Integers table to store number and indicate
	 * whether they are prime or not
	 */
	boolean[] isPrime;
	/**
	 * Internal flag marking that primes cache initialization was successful;
	 */
	boolean initSuccessful;
	/**
	 * Eratosthenes Sieve implementation
	 */
	private void EratosthenesSieve() {
		long startTime = System.currentTimeMillis();
		try {
			int size = maxNumInCache+1;
			if (size <= 0) {
				numberOfPrimes = 0;
				maxNumInCache = 0;
				initSuccessful = false;
				long endTime = System.currentTimeMillis();
				computingTime = (endTime - startTime)/1000.0;
				return;
			}
			isPrime = new boolean[size];
			numberOfPrimes = 0;
			/*
			 * Initially assume all integers are primes
			 */
			isPrime[0] = false;
			isPrime[1] = false;
			for (int i = 2; i <= maxNumInCache; i++) {
				isPrime[i] = true;
				if (mXparser.isCurrentCalculationCancelled()) return;
			}
			/*
			 * Sieve of Eratosthenes - marking non-primes
			 */
	        for (int i = 2; i*i <= maxNumInCache; i++) {
	        	if (mXparser.isCurrentCalculationCancelled()) return;
	            if (isPrime[i] == true)
	                for (int j = i; i*j <= maxNumInCache; j++) {
	                    isPrime[i*j] = false;
	                    if (mXparser.isCurrentCalculationCancelled()) return;
	                }
	        }
			initSuccessful = true;
		} catch (OutOfMemoryError e) {
			initSuccessful = false;
		} finally {
			long endTime = System.currentTimeMillis();
			computingTime = (endTime - startTime)/1000.0;
		}
	}
	/**
	 * Counting found primes
	 */
	private void countPrimes() {
		for (int i = 0; i <= maxNumInCache; i++) {
			if (isPrime[i] == true) numberOfPrimes++;
			if (mXparser.isCurrentCalculationCancelled()) return;
		}
	}
	/**
	 * Default constructor - setting prime cache for a default range if integers
	 */
	public PrimesCache() {
		initSuccessful = false;
		cacheStatus = CACHE_EMPTY;
		maxNumInCache = DEFAULT_MAX_NUM_IN_CACHE;
		EratosthenesSieve();
		if (initSuccessful) {
			countPrimes();
			cacheStatus = CACHING_FINISHED;
		} else {
			maxNumInCache = 0;
			numberOfPrimes = 0;
		}
	}
	/**
	 * Constructor - setting prime cache for a given range if integers
	 * @param maxNumInCache Range of integers to be stored in prime cache
	 */
	public PrimesCache(int maxNumInCache) {
		if (maxNumInCache > 2)
			this.maxNumInCache = Math.min(maxNumInCache, Integer.MAX_VALUE - 1);
		else
			this.maxNumInCache = DEFAULT_MAX_NUM_IN_CACHE;
		initSuccessful = false;
		cacheStatus = CACHE_EMPTY;
		maxNumInCache = DEFAULT_MAX_NUM_IN_CACHE;
		EratosthenesSieve();
		if (initSuccessful) {
			countPrimes();
			cacheStatus = CACHING_FINISHED;
		} else {
			maxNumInCache = 0;
			numberOfPrimes = 0;
		}
	}
	/**
	 * Returns computing time of Eratosthenes Sieve
	 * @return Computing time in seconds
	 */
	public double getComputingTime() {
		return computingTime;
	}
	/**
	 * Returns cache status
	 * @return PrimesCache.CACHE_EMPTY or PrimesCache.CACHING_FINISHED;
	 */
	public boolean getCacheStatus() {
		return cacheStatus;
	}
	/**
	 * Returns number of found primes.
	 * @return Number of found primes.
	 */
	public int getNumberOfPrimes() {
		return numberOfPrimes;
	}
	/**
	 * Returns cache range.
	 * @return Maximum integera number in cache/
	 */
	public int getMaxNumInCache() {
		return maxNumInCache;
	}
	/**
	 * Check whether given number is prime
	 * @param n Given integer number.
	 * @return PrimesCache.IS_PRIME or PrimesCache.IS_NOT_PRIME or PrimesCache.NOT_IN_CACHE
	 */
	public int primeTest(int n) {
		if (n <= 1) return IS_NOT_PRIME;
		if ( (n <= maxNumInCache) && (cacheStatus = CACHING_FINISHED) )
			if ( isPrime[n] == true)
				return IS_PRIME;
			else
				return IS_NOT_PRIME;
		else
			return NOT_IN_CACHE;
	}
	/**
	 * Returns true in case when primes cache initialization was successful,
	 * otherwise returns false.
	 *
	 * @return Returns true in case when primes cache initialization was successful,
	 * otherwise returns false.
	 */
	public boolean isInitSuccessful() {
		return initSuccessful;
	}
	/**
	 * Gets underlying primes cache boolean table
	 * @return Underlying primes cache boolean table
	 */
	boolean[] getPrimes() {
		return isPrime;
	}
}