org.lenskit.results.BasicResultMap 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.results;

import it.unimi.dsi.fastutil.BidirectionalIterator;
import it.unimi.dsi.fastutil.longs.*;
import it.unimi.dsi.fastutil.objects.*;
import org.lenskit.api.Result;
import org.lenskit.util.keys.KeyedObjectMap;

import net.jcip.annotations.Immutable;
import java.util.Comparator;
import java.util.Iterator;
import java.util.Map;
import java.util.NoSuchElementException;

/**
 * Standard result map implementation.
 */
@Immutable
public class BasicResultMap extends AbstractLong2ObjectMap implements LenskitResultMap {
    private static final long serialVersionUID = 1L;

    private final KeyedObjectMap delegate;

    /**
     * Create a new result map from a collection of results.
     * @param objs The results.
     */
    public BasicResultMap(Iterable objs) {
        this(new KeyedObjectMap<>(objs, Results.keyExtractor()));
    }

    BasicResultMap(KeyedObjectMap dlg) {
        delegate = dlg;
    }

    @Override
    public Long2DoubleSortedMap scoreMap() {
        return new ScoreMapImpl();
    }

    @Override
    public Iterator iterator() {
        return delegate.values().iterator();
    }

    @Override
    public ObjectSet> long2ObjectEntrySet() {
        return delegate.long2ObjectEntrySet();
    }

    @Override
    public Result get(long l) {
        return delegate.get(l);
    }

    @Override
    public boolean containsKey(long l) {
        return delegate.containsKey(l);
    }

    @Override
    public ObjectCollection values() {
        return delegate.values();
    }

    @Override
    public ObjectSet> entrySet() {
        return delegate.entrySet();
    }

    @Override
    public LongSet keySet() {
        return delegate.keySet();
    }

    @Override
    public int size() {
        return delegate.size();
    }

    @Override
    public double getScore(long id) {
        Result r = delegate.get(id);
        if (r == null) {
            return Double.NaN;
        } else {
            return r.getScore();
        }
    }

    private class ScoreMapImpl extends AbstractLong2DoubleSortedMap {
        private static final long serialVersionUID = 1L;

        @Override
        public ObjectSortedSet long2DoubleEntrySet() {
            return new ScoreMapEntrySet();
        }

        @Override
        public double get(long l) {
            return getScore(l);
        }

        @Override
        public boolean containsKey(long l) {
            return delegate.containsKey(l);
        }

        @Override
        public LongSortedSet keySet() {
            return delegate.keySet();
        }

        @Override
        public int size() {
            return delegate.size();
        }

        @Override
        public LongComparator comparator() {
            // TODO Implement this method
            return null;
        }

        @Override
        public Long2DoubleSortedMap subMap(long l, long l1) {
            return new BasicResultMap(delegate.subMap(l, l1))
                    .scoreMap();
        }

        @Override
        public Long2DoubleSortedMap headMap(long l) {
            return new BasicResultMap(delegate.headMap(l))
                    .scoreMap();
        }

        @Override
        public Long2DoubleSortedMap tailMap(long l) {
            return new BasicResultMap(delegate.tailMap(l))
                    .scoreMap();
        }

        @Override
        public long firstLongKey() {
            return delegate.firstLongKey();
        }

        @Override
        public long lastLongKey() {
            return delegate.lastLongKey();
        }
    }

    private class ScoreMapEntrySet extends AbstractObjectSortedSet implements AbstractLong2DoubleMap.FastEntrySet {
        @Override
        public ObjectBidirectionalIterator iterator() {
            return new ScoreMapEntryIter();
        }

        @Override
        public ObjectIterator fastIterator() {
            return new ScoreMapEntryFastIter();
        }

        @Override
        public int size() {
            return delegate.size();
        }

        @Override
        public ObjectBidirectionalIterator iterator(Long2DoubleMap.Entry entry) {
            throw new UnsupportedOperationException();
        }

        @Override
        public ObjectSortedSet subSet(Long2DoubleMap.Entry entry, Long2DoubleMap.Entry k1) {
            return new BasicResultMap(delegate.subMap(entry.getLongKey(), k1.getLongKey()))
                    .scoreMap()
                    .long2DoubleEntrySet();
        }

        @Override
        public ObjectSortedSet headSet(Long2DoubleMap.Entry entry) {
            return new BasicResultMap(delegate.headMap(entry.getLongKey()))
                    .scoreMap()
                    .long2DoubleEntrySet();
        }

        @Override
        public ObjectSortedSet tailSet(Long2DoubleMap.Entry entry) {
            return new BasicResultMap(delegate.tailMap(entry.getLongKey()))
                    .scoreMap()
                    .long2DoubleEntrySet();
        }

        @Override
        public Comparator comparator() {
            // TODO Implement this method
            return null;
        }

        @Override
        public Long2DoubleMap.Entry first() {
            if (delegate.isEmpty()) {
                throw new NoSuchElementException();
            } else {
                long k = delegate.firstLongKey();
                return new AbstractLong2DoubleMap.BasicEntry(k, getScore(k));
            }
        }

        @Override
        public Long2DoubleMap.Entry last() {
            if (delegate.isEmpty()) {
                throw new NoSuchElementException();
            } else {
                long k = delegate.lastLongKey();
                return new AbstractLong2DoubleMap.BasicEntry(k, getScore(k));
            }
        }
    }

    private class ScoreMapEntryIter extends AbstractObjectBidirectionalIterator {
        BidirectionalIterator results = delegate.iterator();

        @Override
        public Long2DoubleMap.Entry previous() {
            Result r = results.previous();
            return new AbstractLong2DoubleMap.BasicEntry(r.getId(), r.getScore());
        }

        @Override
        public boolean hasPrevious() {
            return results.hasPrevious();
        }

        public boolean hasNext() {
            return results.hasNext();
        }

        @Override
        public Long2DoubleMap.Entry next() {
            Result r = results.next();
            return new AbstractLong2DoubleMap.BasicEntry(r.getId(), r.getScore());
        }
    }

    private class ScoreMapEntryFastIter extends AbstractObjectBidirectionalIterator {
        BidirectionalIterator results = delegate.iterator();
        ResultScoreEntry entry = new ResultScoreEntry(null);

        @Override
        public Long2DoubleMap.Entry previous() {
            entry.result = results.previous();
            return entry;
        }

        @Override
        public boolean hasPrevious() {
            return results.hasPrevious();
        }

        public boolean hasNext() {
            return results.hasNext();
        }

        @Override
        public Long2DoubleMap.Entry next() {
            entry.result = results.next();
            return entry;
        }
    }

    private static class ResultScoreEntry implements Long2DoubleMap.Entry {
        private Result result;

        public ResultScoreEntry(Result r) {
            result = r;
        }

        @Override
        public long getLongKey() {
            return result.getId();
        }

        @Override
        public double setValue(double v) {
            throw new UnsupportedOperationException();
        }

        @Override
        public double getDoubleValue() {
            return result.getScore();
        }

        @Override
        public Long getKey() {
            return result.getId();
        }

        @Override
        public Double getValue() {
            return result.getScore();
        }

        @Override
        public Double setValue(Double value) {
            throw new UnsupportedOperationException();
        }
    }
}