org.tensorics.core.tensor.lang.OngoingDeferredTensorOperation 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.commons.lang.OngoingOperation;
import org.tensorics.core.commons.options.ManipulationOption;
import org.tensorics.core.commons.options.OptionRegistry;
import org.tensorics.core.expressions.BinaryOperationExpression;
import org.tensorics.core.lang.Tensorics;
import org.tensorics.core.math.ExplicitField;
import org.tensorics.core.math.operations.BinaryOperation;
import org.tensorics.core.tensor.Tensor;
import org.tensorics.core.tensor.operations.ElementBinaryOperation;
import org.tensorics.core.tree.domain.Expression;
import org.tensorics.core.tree.domain.ResolvedExpression;

/**
 * Part of the fluent API for binary (and higher) operations on tensors. It provides methods to define the remaining
 * operands.
 * 
 * @author agorzaws, kfuchbe
 * @param 
 */
public class OngoingDeferredTensorOperation implements OngoingOperation>, V> {

    private final ExplicitField field;
    private final Expression> left;
    private final OptionRegistry optionRegistry;

    /**
     * Creates a new instance of the this ongoing operation.
     * 
     * @param field the field to use
     * @param optionRegistry the registry containing all the options to use for the following operations
     * @param left the expression to be used as the left operand of the following operations
     */
    public OngoingDeferredTensorOperation(ExplicitField field, OptionRegistry optionRegistry,
            Expression> left) {
        this.field = field;
        this.left = left;
        this.optionRegistry = optionRegistry;
    }

    /**
     * Creates an expression that describes the addition of two tensor expressions.
     * 
     * @param right as tensor to add
     * @return result of summing two tensors
     */
    @Override
    public Expression> plus(Expression> right) {
        return evaluate(right, field.addition());
    }

    @Override
    public Expression> minus(Expression> right) {
        return evaluate(right, field.subtraction());
    }

    @Override
    public Expression> elementDividedByV(V value) {
        Tensor right = Tensorics.zeroDimensionalOf(value);
        return elementDividedBy(ResolvedExpression.of(right));
    }

    @Override
    public Expression> elementTimes(Expression> right) {
        return evaluate(right, field.multiplication());
    }

    @Override
    public Expression> elementTimesV(V value) {
        Tensor right = Tensorics.zeroDimensionalOf(value);
        return elementTimes(ResolvedExpression.of(right));
    }

    @Override
    public Expression> elementDividedBy(Expression> right) {
        return evaluate(right, field.division());
    }

    // /**
    // * Calls multiplication operation with question for outupt's {@link ShapingStrategy}
    // *
    // * @param right second tensoric to use
    // * @return Possibility to choose {@link ShapingStrategy}s
    // */
    // public Expression> elementTimes(Expression> right) {
    //
    // }

    // public Expression> elementDividedBy(Expression> right) {
    //
    // }
    // /**
    // * Calls multiplication for single value operation.
    // *
    // * @param value to be multiplied in first Tensoric
    // * @return multiplied tensoric result.
    // */
    // public Expression> elementTimes(V value) {
    //
    // }

    private Expression> evaluate(Expression> right, BinaryOperation operation) {
        return new BinaryOperationExpression<>(new ElementBinaryOperation(operation, optionRegistry), left, right);
    }

}