org.tensorics.core.tensor.lang.QuantityTensors 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.tensor.lang;

import org.tensorics.core.quantity.ImmutableQuantifiedValue;
import org.tensorics.core.quantity.QuantifiedValue;
import org.tensorics.core.tensor.ImmutableTensor;
import org.tensorics.core.tensor.ImmutableTensor.Builder;
import org.tensorics.core.tensor.Position;
import org.tensorics.core.tensor.Tensor;
import org.tensorics.core.units.Unit;

import com.google.common.base.Optional;


/**
 * Provides static utility methods for tensors with quantity values.
 * 
 * @author kfuchsbe
 */
public final class QuantityTensors {

    /**
     * private constructor to avoid instantiation
     */
    private QuantityTensors() {
        /* only static methods */
    }

    public static  Tensor valuesOf(Tensor> tensor) {
        Builder builder = ImmutableTensor.builder(tensor.shape().dimensionSet());
        for (java.util.Map.Entry> entry : tensor.asMap().entrySet()) {
            builder.at(entry.getKey()).put(entry.getValue().value());
        }
        return builder.build();
    }

    public static  Tensor> errorsOf(Tensor> tensor) {
        Builder> builder = ImmutableTensor.builder(tensor.shape().dimensionSet());
        for (java.util.Map.Entry> entry : tensor.asMap().entrySet()) {
            builder.at(entry.getKey()).put(entry.getValue().error());
        }
        return builder.build();
    }

    public static  Tensor errorsOfOr(Tensor> tensor, S defaultValue) {
        Builder builder = ImmutableTensor.builder(tensor.shape().dimensionSet());
        for (java.util.Map.Entry> entry : tensor.asMap().entrySet()) {
            builder.at(entry.getKey()).put(entry.getValue().error().or(defaultValue));
        }
        return builder.build();
    }

    public static  Tensor validitiesOf(Tensor> tensor) {
        Builder builder = ImmutableTensor.builder(tensor.shape().dimensionSet());
        for (java.util.Map.Entry> entry : tensor.asMap().entrySet()) {
            builder.at(entry.getKey()).put(entry.getValue().validity());
        }
        return builder.build();
    }

    public static  Unit unitOf(Tensor> tensor) {
        for (java.util.Map.Entry> entry : tensor.asMap().entrySet()) {
            return entry.getValue().unit();
        }
        throw new IllegalArgumentException("No entries in the given tensor! Cannot find out what is the unit.");
    }

    public static  Tensor> quantityTensorOf(Tensor tensor, Unit unit) {
        Builder> builder = ImmutableTensor.builder(tensor.shape().dimensionSet());
        for (java.util.Map.Entry entry : tensor.asMap().entrySet()) {
            builder.at(entry.getKey()).put(ImmutableQuantifiedValue.of(entry.getValue(), unit));
        }
        return builder.build();
    }

}