org.tensorics.core.tensorbacked.AbstractTensorbacked 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.tensorbacked;

import java.io.Serializable;

import org.tensorics.core.tensor.Tensor;

/**
 * An abstract class for classes that are backed by a tensor. The purpose of such classes is that they can be used for
 * calculations just in the same way (or at least in a similar way) as tensors themselves.
 * 
 * @author kfuchsbe
 * @param  the type of the elements of the tensor, which backs this class
 * @see Tensorbacked
 */
public abstract class AbstractTensorbacked implements Tensorbacked, Serializable {

    private static final long serialVersionUID = 1L;

    protected final Tensor backingTensor;

    public AbstractTensorbacked(Tensor tensor) {
        this.backingTensor = tensor;
    }

    @Override
    public Tensor tensor() {
        return this.backingTensor;
    }

    @Override
    public int hashCode() {
        final int prime = 31;
        int result = 1;
        result = prime * result + ((backingTensor == null) ? 0 : backingTensor.hashCode());
        return result;
    }

    @Override
    public boolean equals(Object obj) {
        if (this == obj) {
            return true;
        }
        if (obj == null) {
            return false;
        }
        if (getClass() != obj.getClass()) {
            return false;
        }
        AbstractTensorbacked other = (AbstractTensorbacked) obj;
        if (backingTensor == null) {
            if (other.backingTensor != null) {
                return false;
            }
        } else if (!backingTensor.equals(other.backingTensor)) {
            return false;
        }
        return true;
    }

    @Override
    public String toString() {
        return getClass().getSimpleName() + " [backingTensor=" + backingTensor + "]";
    }

}