org.tensorics.core.iterable.lang.ScalarIterableSupport Maven / Gradle / Ivy

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

Tensorics is a java framework which uses a tensor as a central object. A tensor represents a set of values placed in an N-dimensional space. Wherever you are tempted to use maps of maps, a tensor might be a good choice ;-) Tensorics provides methods to create, transform and performing calculations with those tensors.

There is a newer version: 0.0.81

Show newest version

// @formatter:off
 /*******************************************************************************
 *
 * This file is part of tensorics.
 * 
 * Copyright (c) 2008-2011, CERN. All rights reserved.
 *
 * 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.
 * 
 ******************************************************************************/
// @formatter:on

package org.tensorics.core.iterable.lang;

import org.tensorics.core.math.ExtendedField;
import org.tensorics.core.scalar.lang.ScalarSupport;

/**
 * Provides utility methods for acting on collections of field elements.
 * 
 * @author kfuchsbe
 * @param  the type of the values of the field
 */
public class ScalarIterableSupport extends ScalarSupport {

    private final IterableOperationRepository repository;

    public ScalarIterableSupport(ExtendedField field) {
        super(field);
        this.repository = new IterableOperationRepository<>(field);
    }

    public final V averageOf(Iterable values) {
        return repository.average().apply(values);
    }

    public final V sizeOf(Iterable values) {
        return repository.size().apply(values);
    }

    public final V sumOf(Iterable values) {
        return repository.sum().apply(values);
    }

    public V rmsOf(Iterable values) {
        return repository.rms().apply(values);
    }

    public V sumOfSquaresOf(Iterable values) {
        return repository.sumOfSquares().apply(values);
    }
    
    public V varOf(Iterable values) {
        return repository.var().apply(values);
    }
    
    public V stdOf(Iterable values) {
        return repository.std().apply(values);
    }

}