nom.bdezonia.zorbage.algorithm.NanSumWithCount Maven / Gradle / Ivy

Go to download
/*
 * Zorbage: an algebraic data hierarchy for use in numeric processing.
 *
 * Copyright (c) 2016-2021 Barry DeZonia All rights reserved.
 * 
 * Redistribution and use in source and binary forms, with or without modification,
 * are permitted provided that the following conditions are met:
 * 
 * Redistributions of source code must retain the above copyright notice, this list
 * of conditions and the following disclaimer.
 * 
 * Redistributions in binary form must reproduce the above copyright notice, this
 * list of conditions and the following disclaimer in the documentation and/or other
 * materials provided with the distribution.
 * 
 * Neither the name of the  nor the names of its contributors may
 * be used to endorse or promote products derived from this software without specific
 * prior written permission.
 * 
 * THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "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  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 SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH
 * DAMAGE.
 */
package nom.bdezonia.zorbage.algorithm;

import nom.bdezonia.zorbage.algebra.Addition;
import nom.bdezonia.zorbage.algebra.Algebra;
import nom.bdezonia.zorbage.algebra.NaN;
import nom.bdezonia.zorbage.algebra.Unity;
import nom.bdezonia.zorbage.datasource.IndexedDataSource;

/**
 * 
 * @author Barry DeZonia
 *
 */
public class NanSumWithCount {

	// do not instantiate
	
	private NanSumWithCount() {}
	
	/**
	 * Calculate the sum and count of non-NaN values in a list of numbers.
	 * 
	 * @param alg
	 * @param storage
	 * @param sum
	 * @param count
	 */
	public static  & Addition & Unity & NaN, U>
		void compute(T alg, IndexedDataSource storage, U sum, U count)
	{
		boolean foundSome = false;
		U tmpSum = alg.construct();
		U tmpCnt = alg.construct();
		U value = alg.construct();
		U one = alg.construct();
		alg.unity().call(one);
		long size = storage.size();
		if (size == 0)
			throw new IllegalArgumentException("nan sum with count called with empty list");
		for (long i = 0; i < size; i++) {
			storage.get(i, value);
			if (!alg.isNaN().call(value)) {
				foundSome = true;
				alg.add().call(tmpSum, value, tmpSum);
				alg.add().call(tmpCnt, one, tmpCnt);
			}
		}
		if (foundSome) {
			alg.assign().call(tmpSum, sum);
			alg.assign().call(tmpCnt, count);
		}
		else {
			alg.nan().call(sum);
			alg.zero().call(count);
		}
	}
}