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

import java.util.Collections;
import java.util.List;

import org.tensorics.core.tree.domain.Expression;
import org.tensorics.core.tree.domain.ExpressionIsUnresolvedException;
import org.tensorics.core.tree.domain.Node;

/**
 * This class is intended to be subclassed in order to describe calculations with tensorics, which shall be executed at
 * a later time. This class itself inherits from {@link TensoricExpressionSupport} such that it provides the full
 * capability of the eDSL.
 * 
 * To define a script, a field has to be given in the constructor, which describes all the operations which can be
 * performed on its elements.
 * 
 * The script logic itself has to be implemented in the {@link #describe()} method. To resolve a script, a
 * {@link org.tensorics.core.resolve.engine.ResolvingEngine} has to be used.
 * 
 * @author kfuchsbe
 * @param  the type of the elements of the field on which all the calculations are based on.
 * @param  the type which shall be returned by the script, after it is executed (resolved)
 */
public abstract class TensoricScript extends TensoricExpressionSupport implements Expression {

    private static final boolean RESOLVED = false;
    private final Expression internalExpression;

    public TensoricScript(EnvironmentImpl environment) {
        super(environment);
        internalExpression = describe();
    }

    protected abstract Expression describe();

    @Override
    public List getChildren() {
        return Collections. singletonList(internalExpression);
    }

    @Override
    public boolean isResolved() {
        return RESOLVED;
    }

    @Override
    public T get() {
        throw new ExpressionIsUnresolvedException();
    }

    public Expression getInternalExpression() {
        return internalExpression;
    }

}