RFTester Tool for automated testing relevance feedback algorithms fro known-item search

Public Member Functions | Protected Member Functions | Protected Attributes | Static Protected Attributes | Properties | List of all members
RFTesterBackend.Rankers.AbstractRanker Class Referenceabstract
Inheritance diagram for RFTesterBackend.Rankers.AbstractRanker:

## Public Member Functions
abstract string | GetName ()
| Returns the name of the component. More...
abstract List< EvaluationClassParAdditional > | OtherParametersToFill ()
| Returns list of parameters, that can be changed More...
abstract void | rescore (List< int > likeIds, List< int > seenIds)
| Applies updates rule for given likes and seen ids. More...
abstract void | SetOtherParameters (List< EvaluationClassParAdditional > userParameters)
| Sets parameters of component. More...
| AbstractRanker (List< int > imageIds)
void | Normalize ()
| Normalizes relevance scores. More...
void | StretchToOne ()
| Divides all the relevance scores by maximum score. More...
void | Reset (List< int > likes, List< int > seenIds)
virtual IMeasurer | GetMeasurer ()
| Returns measurer the user should be using. More...
virtual double | ExponentForKwInit ()

## Protected Member Functions
virtual void | init ()
double | InternalCosineDistance (int o1, int o2)
double | InternalManhattanDistance (int o1, int o2)

## Protected Attributes
double[] | scores

## Static Protected Attributes
static log4net.ILog | logger = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType)
static readonly double | DEF_SCORE = 1
static readonly double | DEF_FILTERED_SCORE = 0f

## Properties
IDisplayGenerator | DisplayGenerator`[get, set]`
ReadOnlyCollection< int > | ImageIds`[get, private set]`
double[] | Scores`[get, set]`
Properties inherited from RFTesterBackend.Rankers.IRanker
double[] | Scores`[get, set]`
| Access property for getting relevance scores. More...
ReadOnlyCollection< int > | ImageIds`[get]`
| Returns collection of ids of images that the rankers is computing on. More...

## Constructor & Destructor Documentation

## ◆ AbstractRanker()

RFTesterBackend.Rankers.AbstractRanker.AbstractRanker | ( | List< int > | imageIds | ) |
| inline

## Member Function Documentation

## ◆ ExponentForKwInit()

virtual double RFTesterBackend.Rankers.AbstractRanker.ExponentForKwInit | ( |  | ) |
| inlinevirtual

Reimplemented in RFTesterBackend.Rankers.BayesianIndepRanker.

## ◆ GetMeasurer()

virtual IMeasurer RFTesterBackend.Rankers.AbstractRanker.GetMeasurer | ( |  | ) |
| inlinevirtual

Returns measurer the user should be using.

Returns

Implements RFTesterBackend.Rankers.IRanker.

## ◆ GetName()

abstract string RFTesterBackend.Rankers.AbstractRanker.GetName | ( |  | ) |
| pure virtual

Returns the name of the component.

Returns

Implements RFTesterBackend.Evaluator.IEvaluationClassPar.

Implemented in RFTesterBackend.Rankers.BayesianIndepRanker.

## ◆ init()

virtual void RFTesterBackend.Rankers.AbstractRanker.init | ( |  | ) |
| inlineprotectedvirtual

Reimplemented in RFTesterBackend.Rankers.BayesianIndepRanker.

## ◆ InternalCosineDistance()

double RFTesterBackend.Rankers.AbstractRanker.InternalCosineDistance | ( | int | o1,
|  | int | o2
| ) |  |
| inlineprotected

## ◆ InternalManhattanDistance()

double RFTesterBackend.Rankers.AbstractRanker.InternalManhattanDistance | ( | int | o1,
|  | int | o2
| ) |  |
| inlineprotected

## ◆ Normalize()

void RFTesterBackend.Rankers.AbstractRanker.Normalize | ( |  | ) |
| inline

Normalizes relevance scores.

Implements RFTesterBackend.Rankers.IRanker.

## ◆ OtherParametersToFill()

abstract List<EvaluationClassParAdditional> RFTesterBackend.Rankers.AbstractRanker.OtherParametersToFill | ( |  | ) |
| pure virtual

Returns list of parameters, that can be changed

Returns

Implements RFTesterBackend.Evaluator.IEvaluationClassPar.

Implemented in RFTesterBackend.Rankers.BayesianIndepRanker.

## ◆ rescore()

abstract void RFTesterBackend.Rankers.AbstractRanker.rescore | ( | List< int > | likeIds,
|  | List< int > | seenIds
| ) |  |
| pure virtual

Applies updates rule for given likes and seen ids.

Parameters

  likeIds |
  seenIds |

Implements RFTesterBackend.Rankers.IRanker.

Implemented in RFTesterBackend.Rankers.BayesianIndepRanker.

## ◆ Reset()

void RFTesterBackend.Rankers.AbstractRanker.Reset | ( | List< int > | likes,
|  | List< int > | seenIds
| ) |  |
| inline

## ◆ SetOtherParameters()

abstract void RFTesterBackend.Rankers.AbstractRanker.SetOtherParameters | ( | List< EvaluationClassParAdditional > | userParameters | ) |
| pure virtual

Sets parameters of component.

Must contain all the parameters from OtherParametersToFill().

Parameters

  userParameters |

Implements RFTesterBackend.Evaluator.IEvaluationClassPar.

Implemented in RFTesterBackend.Rankers.BayesianIndepRanker.

## ◆ StretchToOne()

void RFTesterBackend.Rankers.AbstractRanker.StretchToOne | ( |  | ) |
| inline

Divides all the relevance scores by maximum score.

Prevents underflowing floating point operaionts.

Implements RFTesterBackend.Rankers.IRanker.

## Member Data Documentation

## ◆ DEF_FILTERED_SCORE

readonly double RFTesterBackend.Rankers.AbstractRanker.DEF_FILTERED_SCORE = 0f
| staticprotected

## ◆ DEF_SCORE

readonly double RFTesterBackend.Rankers.AbstractRanker.DEF_SCORE = 1
| staticprotected

## ◆ logger

log4net.ILog RFTesterBackend.Rankers.AbstractRanker.logger = log4net.LogManager.GetLogger(System.Reflection.MethodBase.GetCurrentMethod().DeclaringType)
| staticprotected

## ◆ scores

double [] RFTesterBackend.Rankers.AbstractRanker.scores
| protected

## Property Documentation

## ◆ DisplayGenerator

IDisplayGenerator RFTesterBackend.Rankers.AbstractRanker.DisplayGenerator
| getset

## ◆ ImageIds

ReadOnlyCollection<int> RFTesterBackend.Rankers.AbstractRanker.ImageIds
| getprivate set

## ◆ Scores

double [] RFTesterBackend.Rankers.AbstractRanker.Scores
| getset

The documentation for this class was generated from the following file:

- RFTesterBackend/Rankers/AbstractRanker.cs