org.grouplens.lenskit.mf.svd.DomainClampingKernel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lenskit-svd Show documentation
There is a newer version: 3.0-T5
/*
 * LensKit, an open source recommender systems toolkit.
 * Copyright 2010-2014 LensKit Contributors.  See CONTRIBUTORS.md.
 * Work on LensKit has been funded by the National Science Foundation under
 * grants IIS 05-34939, 08-08692, 08-12148, and 10-17697.
 *
 * This program is free software; you can redistribute it and/or modify
 * it under the terms of the GNU Lesser General Public License as
 * published by the Free Software Foundation; either version 2.1 of the
 * License, or (at your option) any later version.
 *
 * This program is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS
 * FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
 * details.
 *
 * You should have received a copy of the GNU General Public License along with
 * this program; if not, write to the Free Software Foundation, Inc., 51
 * Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
 */
package org.grouplens.lenskit.mf.svd;

import com.google.common.base.Preconditions;
import mikera.vectorz.AVector;
import org.grouplens.lenskit.core.Shareable;
import org.grouplens.lenskit.data.pref.PreferenceDomain;

import javax.annotation.Nonnull;
import javax.annotation.concurrent.Immutable;
import javax.inject.Inject;
import java.io.Serializable;

/**
 * Kernel that clamps each feature's contribution to the preference domain.
 *
 * @since 2.1
 * @author GroupLens Research
 */
@Shareable
@Immutable
public class DomainClampingKernel implements BiasedMFKernel, Serializable {
    private static final long serialVersionUID = 1L;

    private final PreferenceDomain domain;

    @Inject
    public DomainClampingKernel(PreferenceDomain dom) {
        domain = dom;
    }

    @Override
    public double apply(double bias, @Nonnull AVector user, @Nonnull AVector item) {
        final int n = user.length();
        Preconditions.checkArgument(item.length() == n, "vectors have different lengths");

        double result = bias;
        for (int i = 0; i < n; i++) {
            result = domain.clampValue(result + user.get(i) * item.get(i));
        }
        return result;
    }

    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        DomainClampingKernel that = (DomainClampingKernel) o;

        return domain.equals(that.domain);
    }

    @Override
    public int hashCode() {
        return domain.hashCode();
    }

    @Override
    public String toString() {
        return "ClampKernel(" + domain + ")";
    }
}