ConstantVector.java

/*
 * Licensed to the Apache Software Foundation (ASF) under one or more
 * contributor license agreements.  See the NOTICE file distributed with
 * this work for additional information regarding copyright ownership.
 * The ASF licenses this file to You 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.
 */

package org.apache.ignite.ml.math.impls.vector;

import org.apache.ignite.ml.math.Matrix;
import org.apache.ignite.ml.math.Vector;
import org.apache.ignite.ml.math.VectorStorage;
import org.apache.ignite.ml.math.exceptions.UnsupportedOperationException;
import org.apache.ignite.ml.math.impls.storage.vector.ConstantVectorStorage;

/**
 * Constant value, read-only vector.
 */
public class ConstantVector extends AbstractReadOnlyVector {
    /**
     *
     */
    public ConstantVector() {
        // No-op.
    }

    /**
     * @param size Vector size.
     * @param val Value of the constant.
     */
    public ConstantVector(int size, double val) {
        super(new ConstantVectorStorage(size, val));
    }

    /**
     *
     *
     */
    private ConstantVectorStorage storage() {
        return (ConstantVectorStorage)getStorage();
    }

    /** {@inheritDoc} */
    @Override public Vector copy() {
        ConstantVectorStorage sto = storage();

        return new ConstantVector(sto.size(), sto.constant());
    }

    /** {@inheritDoc} */
    @Override public Vector like(int crd) {
        return new ConstantVector(crd, storage().constant());
    }

    /** {@inheritDoc} */
    @Override public Matrix likeMatrix(int rows, int cols) {
        throw new UnsupportedOperationException();
    }

    /** {@inheritDoc} */
    @Override public boolean equals(Object o) {
        if (this == o)
            return true;

        if (o == null || getClass() != o.getClass())
            return false;

        ConstantVector that = (ConstantVector)o;

        VectorStorage sto = getStorage();

        return (sto != null ? sto.equals(that.getStorage()) : that.getStorage() == null);
    }
}