org.tensorics.core.math.Cheating 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.math;

/**
 * This interface provides methods for field elements, whose usage is highly discouraged and should be avoided.
 * Currently, they are necessary, mainly because no unit-treatment implementation is available, which is purely baes on
 * fields. We hope to get rid of this at some point, therefore clients should NOT use these methods.
 * 
 * Currently, this interface provides conversion methods from/to double. This is required for the current implementation
 * of unit conversions. The general plan for the future is to also base the unit conversions fully on the field
 * structure, therefore, these two methods are marked as deprecated, to avoid that clients start rely on them and abuse
 * them.
 * 
 * @author kfuchsbe
 * @param 
 */
public interface Cheating {

    /**
     * Has to return a field element, constructed from the given double value.
     * 
     * @param value the double value from which to construct the field element.
     * @return the field element constructed from the double value
     */
    T fromDouble(double value);

    /**
     * Has to convert the given field element to a (unique) double value.
     * 
     * @param value field element to convert
     * @return a double value related to the field
     */
    double toDouble(T value);
}