ScoredIdListBuilder (LensKit 2.2.1)

java.lang.Object
- org.grouplens.lenskit.scored.ScoredIdListBuilder

All Implemented Interfaces:

org.apache.commons.lang3.builder.Builder<PackedScoredIdList>
```
public class ScoredIdListBuilder
extends Object
implements org.apache.commons.lang3.builder.Builder<PackedScoredIdList>
```
Builder for packed lists of scored ids. All ids in the resulting list will have the same set of side channels.

Since:

1.4

Compatibility

Public

Constructor Summary

Constructors
Constructor and Description

ScoredIdListBuilder()

ScoredIdListBuilder(int cap)

Constructors
Constructor and Description
`ScoredIdListBuilder()`
`ScoredIdListBuilder(int cap)`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`ScoredIdListBuilder`	`add(long id, double score)` Add a scored ID without boxing.
`ScoredIdListBuilder`	`add(ScoredId id)` Add a scored ID.
`ScoredIdListBuilder`	`addAll(Iterable<ScoredId> ids)` Add a collection of IDs.
`ScoredIdListBuilder`	`addChannel(Symbol sym)` Add a side channel to the list builder with a default value of 0.
`ScoredIdListBuilder`	`addChannel(Symbol sym, double dft)` Add a side channel to the list builder.
`ScoredIdListBuilder`	`addChannel(TypedSymbol<?> sym)` Add a side channel to the list builder.
`<T> ScoredIdListBuilder`	`addChannel(TypedSymbol<T> sym, T dft)` Add a typed side channel to the list builder.
`ScoredIdListBuilder`	`addChannels(Iterable<Symbol> channels)` Add multiple unboxed channels with a default value of 0.
`ScoredIdListBuilder`	`addTypedChannels(Iterable<? extends TypedSymbol<?>> channels)` Add multiple channels with a default value of `null`.
`PackedScoredIdList`	`build()`
`ImmutableSparseVector`	`buildVector()` Build a sparse vector directly from the list of IDs.
`void`	`clear()` Clear the builder.
`ScoredIdListBuilder`	`failOnUnknownChannels()` Set the builder to fail on unknown channels.
`PackedScoredIdList`	`finish()` Destructive version of `build()`, re-using storage if possible.
`ScoredIdListBuilder`	`ignoreUnknownChannels()` Set the builder to ignore unknown channels on IDs passed to `add(ScoredId)`.
`int`	`size()` Get the number of items currently in the builder.
`ScoredIdListBuilder`	`sort(Comparator<ScoredId> order)` Sort the list-in-progress by the specified comparator.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - ScoredIdListBuilder
```
public ScoredIdListBuilder()
```
  - ScoredIdListBuilder
```
public ScoredIdListBuilder(int cap)
```
- Method Detail
  - build
```
public PackedScoredIdList build()
```
    Specified by:
    
    build in interface org.apache.commons.lang3.builder.Builder<PackedScoredIdList>
  - finish
```
public PackedScoredIdList finish()
```
    Destructive version of build(), re-using storage if possible. Future use of the builder is impossible, and all memory used by it is released.
    
    Returns:
    
    The scored ID list.
  - clear
```
public void clear()
```
    Clear the builder. After it is cleared, it can no longer be used.
  - buildVector
```
public ImmutableSparseVector buildVector()
```
    Build a sparse vector directly from the list of IDs. This allows a scored ID list builder to be used to efficiently accumulate a sparse vector. If the same ID is added multiple times, the first instance is used.
    
    Returns:
    
    A sparse vector containing the data accumulated.
  - size
```
public int size()
```
    Get the number of items currently in the builder.
    
    Returns:
    
    The number of items in the builder.
  - add
```
public ScoredIdListBuilder add(long id,
                               double score)
```
    Add a scored ID without boxing. The default value will be used for each channel.
    
    Parameters:
    
    id - The ID to add.
    
    score - The score for the ID.
    
    Returns:
    
    The builder (for chaining).
  - add
```
public ScoredIdListBuilder add(ScoredId id)
```
    Add a scored ID. The ID is copied into the builder, not referenced. All side channels on the ID must have already been added with one of the addChannel methods.
    
    Parameters:
    
    id - The ID.
    
    Returns:
    
    The builder (for chaining).
  - addAll
```
public ScoredIdListBuilder addAll(Iterable<ScoredId> ids)
```
    Add a collection of IDs. The IDs are copied into the builder, not referenced.
    
    Parameters:
    
    ids - The IDs to add.
    
    Returns:
    
    The builder (for chaining)
  - addChannel
```
public ScoredIdListBuilder addChannel(Symbol sym)
```
    Add a side channel to the list builder with a default value of 0. It is an error to add the same symbol multiple times. All side channels that will be used must be added prior to calling add(ScoredId).
    
    Parameters:
    
    sym - The symbol to add.
    
    Returns:
    
    The builder (for chaining).
    
    See Also:
    
    addChannel(Symbol, double)
  - addChannel
```
public ScoredIdListBuilder addChannel(Symbol sym,
                                      double dft)
```
    Add a side channel to the list builder. It is an error to add the same symbol multiple times. All side channels that will be used must be added prior to calling add(ScoredId).
    
    Parameters:
    
    sym - The symbol to add.
    
    dft - The default value when adding IDs that lack this channel.
    
    Returns:
    
    The builder (for chaining).
  - addChannels
```
public ScoredIdListBuilder addChannels(Iterable<Symbol> channels)
```
    Add multiple unboxed channels with a default value of 0.
    
    Parameters:
    
    channels - The channels to add.
    
    Returns:
    
    The builder (for chaining).
  - addChannel
```
public ScoredIdListBuilder addChannel(TypedSymbol<?> sym)
```
    Add a side channel to the list builder. It is an error to add the same symbol multiple times. All side channels that will be used must be added prior to calling add(ScoredId).
    
    Parameters:
    
    sym - The symbol to add.
    
    Returns:
    
    The builder (for chaining).
    
    See Also:
    
    addChannel(TypedSymbol, Object)
  - addChannel
```
public <T> ScoredIdListBuilder addChannel(TypedSymbol<T> sym,
                                          T dft)
```
    Add a typed side channel to the list builder. It is an error to add the same symbol multiple times. All side channels that will be used must be added prior to calling add(ScoredId).
    
    Parameters:
    
    sym - The symbol to add.
    
    dft - The default value when adding ids that lack this channel. If null, it will be omitted from such ids.
    
    Returns:
    
    The builder (for chaining).
  - addTypedChannels
```
public ScoredIdListBuilder addTypedChannels(Iterable<? extends TypedSymbol<?>> channels)
```
    Add multiple channels with a default value of null.
    
    Parameters:
    
    channels - The channels to add.
    
    Returns:
    
    The builder (for chaining).
  - ignoreUnknownChannels
```
public ScoredIdListBuilder ignoreUnknownChannels()
```
    Set the builder to ignore unknown channels on IDs passed to add(ScoredId).
    
    Returns:
    
    The builder (for chaining).
  - failOnUnknownChannels
```
public ScoredIdListBuilder failOnUnknownChannels()
```
    Set the builder to fail on unknown channels. This is the default response to unknown channels.
    
    Returns:
    
    The builder (for chaining).
  - sort
```
public ScoredIdListBuilder sort(Comparator<ScoredId> order)
```
    Sort the list-in-progress by the specified comparator.
    
    Parameters:
    
    order - The comparator.
    
    Returns:
    
    The buidler (for chaining).

Class ScoredIdListBuilder

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

ScoredIdListBuilder

ScoredIdListBuilder

Method Detail

build

finish

clear

buildVector

size

add

add

addAll

addChannel

addChannel

addChannels

addChannel

addChannel

addTypedChannels

ignoreUnknownChannels

failOnUnknownChannels

sort