the-algorithm/product-mixer/component-library/src/main/scala/com/twitter/product_mixer/component_library/selector/InsertFixedPositionResults.scala
twitter-team ef4c5eb65e Twitter Recommendation Algorithm
Please note we have force-pushed a new initial commit in order to remove some publicly-available Twitter user information. Note that this process may be required in the future.
2023-03-31 17:36:31 -05:00

47 lines
1.9 KiB
Scala

package com.twitter.product_mixer.component_library.selector
import com.twitter.product_mixer.core.functional_component.common.CandidateScope
import com.twitter.product_mixer.core.functional_component.common.SpecificPipeline
import com.twitter.product_mixer.core.functional_component.common.SpecificPipelines
import com.twitter.product_mixer.core.functional_component.selector.Selector
import com.twitter.product_mixer.core.functional_component.selector.SelectorResult
import com.twitter.product_mixer.core.model.common.identifier.CandidatePipelineIdentifier
import com.twitter.product_mixer.core.model.common.presentation.CandidateWithDetails
import com.twitter.product_mixer.core.pipeline.PipelineQuery
import com.twitter.timelines.configapi.Param
object InsertFixedPositionResults {
def apply(
candidatePipeline: CandidatePipelineIdentifier,
positionParam: Param[Int],
): InsertFixedPositionResults =
new InsertFixedPositionResults(SpecificPipeline(candidatePipeline), positionParam)
def apply(
candidatePipelines: Set[CandidatePipelineIdentifier],
positionParam: Param[Int]
): InsertFixedPositionResults =
new InsertFixedPositionResults(SpecificPipelines(candidatePipelines), positionParam)
}
/**
* Insert all candidates in a pipeline scope at a 0-indexed fixed position. If the current
* results are a shorter length than the requested position, then the candidates will be appended
* to the results.
*/
case class InsertFixedPositionResults(
override val pipelineScope: CandidateScope,
positionParam: Param[Int])
extends Selector[PipelineQuery] {
override def apply(
query: PipelineQuery,
remainingCandidates: Seq[CandidateWithDetails],
result: Seq[CandidateWithDetails]
): SelectorResult = InsertSelector.insertIntoResultsAtPosition(
position = query.params(positionParam),
pipelineScope = pipelineScope,
remainingCandidates = remainingCandidates,
result = result)
}