org.apache.mahout.math.WeightedVector.java Source code

Introduction

Here is the source code for org.apache.mahout.math.WeightedVector.java

Source

/*
 * 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.mahout.math;

/**
 * Decorates a vector with a floating point weight and an index.
 */
public class WeightedVector extends DelegatingVector {
    private static final int INVALID_INDEX = -1;
    private double weight;
    private int index;

    protected WeightedVector(double weight, int index) {
        super();
        this.weight = weight;
        this.index = index;
    }

    public WeightedVector(Vector v, double weight, int index) {
        super(v);
        this.weight = weight;
        this.index = index;
    }

    public WeightedVector(Vector v, Vector projection, int index) {
        super(v);
        this.index = index;
        this.weight = v.dot(projection);
    }

    public static WeightedVector project(Vector v, Vector projection) {
        return project(v, projection, INVALID_INDEX);
    }

    public static WeightedVector project(Vector v, Vector projection, int index) {
        return new WeightedVector(v, projection, index);
    }

    public double getWeight() {
        return weight;
    }

    public int getIndex() {
        return index;
    }

    public void setWeight(double newWeight) {
        this.weight = newWeight;
    }

    public void setIndex(int index) {
        this.index = index;
    }

    @Override
    public Vector like() {
        return new WeightedVector(getVector().like(), weight, index);
    }

    @Override
    public String toString() {
        return String.format("index=%d, weight=%.2f, v=%s", index, weight, getVector());
    }

    @Override
    public WeightedVector clone() {
        WeightedVector v = (WeightedVector) super.clone();
        v.weight = weight;
        v.index = index;
        return v;
    }
}