org.lenskit.bias.UserItemBiasModel Maven / Gradle / Ivy

Go to download
Show more of this group Show more artifacts with this name
Show all versions of lenskit-core Show documentation
The core of LensKit, providing basic implementations and algorithm support.
The newest version!
/*
 * LensKit, an open source recommender systems toolkit.
 * Copyright 2010-2016 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.lenskit.bias;

import it.unimi.dsi.fastutil.longs.Long2DoubleMap;
import it.unimi.dsi.fastutil.longs.LongSet;
import org.grouplens.grapht.annotation.DefaultProvider;
import org.lenskit.inject.Shareable;
import org.lenskit.util.keys.Long2DoubleSortedArrayMap;

import net.jcip.annotations.Immutable;
import java.io.Serializable;

/**
 * Bias model that provides global, user, and item biases.  The user and item biases are precomputed and are *not*
 * refreshed based on user data added since the model build.
 */
@Shareable
@Immutable
@DefaultProvider(UserItemAverageRatingBiasModelProvider.class)
public class UserItemBiasModel implements BiasModel, Serializable {
    private static final long serialVersionUID = 1L;

    private final double intercept;
    private final Long2DoubleSortedArrayMap userBiases;
    private final Long2DoubleSortedArrayMap itemBiases;

    /**
     * Construct a new user bias model.
     * @param global The global bias.
     * @param users The user biases.
     * @param items The item biases.
     */
    public UserItemBiasModel(double global, Long2DoubleMap users, Long2DoubleMap items) {
        intercept = global;
        userBiases = Long2DoubleSortedArrayMap.create(users);
        itemBiases = Long2DoubleSortedArrayMap.create(items);
    }

    @Override
    public double getIntercept() {
        return intercept;
    }

    @Override
    public double getUserBias(long user) {
        return userBiases.get(user);
    }

    @Override
    public Long2DoubleMap getUserBiases(LongSet users) {
        return userBiases.subMap(users);
    }

    @Override
    public Long2DoubleMap getUserBiases() {
        return userBiases;
    }

    @Override
    public double getItemBias(long item) {
        return itemBiases.get(item);
    }

    @Override
    public Long2DoubleMap getItemBiases(LongSet items) {
        return itemBiases.subMap(items);
    }

    @Override
    public Long2DoubleMap getItemBiases() {
        return itemBiases;
    }
}