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

import static com.google.common.base.Preconditions.checkNotNull;

import java.io.Serializable;
import java.util.Set;

/**
 * A class that contains a limited (or zero - empty) additional informations about tensor shape/dimensions. 

 * 

 * List of the coordinates will return instances of This object should remain immutable as it is an unchangeable
 * property of the data held in {@link Tensor}.
 * 
 * @author agorzaws
 */
public final class Context implements Serializable {

    private static final long serialVersionUID = 1L;

    private static final Context EMPTY_CONTEXT = Context.of(Position.empty());

    private final Position position;

    private Context(Position position) {
        this.position = checkNotNull(position, "position must not be null");
    }

    /**
     * @return the context content
     */
    public Position getPosition() {
        return position;
    }

    /**
     * @param coordinates to be saved in context/position
     * @return a Context
     */
    @SuppressWarnings("PMD.ShortMethodName")
    public static Context of(Set coordinates) {
        return of(Position.of(coordinates));
    }

    @SuppressWarnings("PMD.ShortMethodName")
    public static Context of(Object... coordinates) {
        return of(Position.of(coordinates));
    }

    @SuppressWarnings("PMD.ShortMethodName")
    public static Context of(Position position) {
        return new Context(position);
    }

    /**
     * @return creates a default empty context.
     */
    public static Context empty() {
        return EMPTY_CONTEXT;
    }

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

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

    @Override
    public String toString() {
        return "Context [position=" + position + "]";
    }
}