org.tensorics.core.tensor.expressions.TensorExpressions 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.expressions;

import org.tensorics.core.commons.options.ManipulationOption;
import org.tensorics.core.commons.options.OptionRegistry;
import org.tensorics.core.expressions.BinaryOperationExpression;
import org.tensorics.core.expressions.CreationOperationExpression;
import org.tensorics.core.expressions.UnaryOperationExpression;
import org.tensorics.core.math.operations.BinaryOperation;
import org.tensorics.core.math.operations.UnaryOperation;
import org.tensorics.core.tensor.Shape;
import org.tensorics.core.tensor.Tensor;
import org.tensorics.core.tensor.operations.ElementBinaryOperation;
import org.tensorics.core.tensor.operations.ElementUnaryOperation;
import org.tensorics.core.tensor.operations.SingleValueTensorCreationOperation;
import org.tensorics.core.tree.domain.Expression;

/**
 * Provides factory methods for tensor expressions
 * 
 * @author kfuchsbe
 */
public final class TensorExpressions {

    /**
     * Private constructor to avoid instantiation
     */
    private TensorExpressions() {
        /* Only static methods */
    }

    public static  Expression> elementwise(UnaryOperation operation, Expression> tensor) {
        return new UnaryOperationExpression<>(new ElementUnaryOperation(operation), tensor);
    }

    public static  CreationOperationExpression> creationOfShapeValue(Shape shape, V value) {
        return new CreationOperationExpression<>(new SingleValueTensorCreationOperation<>(shape, value));
    }

    /* Not nice too have four parameters here, could be refactored */
    public static  Expression> elementwise(BinaryOperation operation, // NOSONAR (too many parameters)
            Expression> leftTensor, Expression> right, OptionRegistry options) {
        ElementBinaryOperation elementQuantifiedBinaryOperation = new ElementBinaryOperation<>(operation, options);
        return new BinaryOperationExpression<>(elementQuantifiedBinaryOperation, leftTensor, right);
    }
}