Structure holding a board for all the types of score/matching having been performed. More...

#include <opentrep/bom/ScoreBoard.hpp>

Inheritance diagram for OPENTREP::ScoreBoard:

Public Types
typedef std::map < ScoreType::EN_ScoreType, Score_T >	ScoreMap_T

Public Member Functions
const TravelQuery_T &	getQueryString () const

const ScoreMap_T &	getScoreMap () const

Score_T	getScore (const ScoreType &) const

Score_T	getCombinedWeight () const

void	setQueryString (const TravelQuery_T &iQueryString)

void	setScore (const ScoreType &, const Score_T &)

void	setCombinedWeight (const Score_T &iScore)

Percentage_T	calculateCombinedWeight ()

void	toStream (std::ostream &) const

void	fromStream (std::istream &)

std::string	describeKey () const

std::string	describe () const

	ScoreBoard (const TravelQuery_T &, const ScoreType &, const Score_T &)

	ScoreBoard (const TravelQuery_T &)

	ScoreBoard (const ScoreBoard &)

	~ScoreBoard ()

Detailed Description

Structure holding a board for all the types of score/matching having been performed.

Definition at line 22 of file ScoreBoard.hpp.

Member Typedef Documentation

typedef std::map<ScoreType::EN_ScoreType, Score_T> OPENTREP::ScoreBoard::ScoreMap_T

(STL) map of scores.

Definition at line 28 of file ScoreBoard.hpp.

Constructor & Destructor Documentation

OPENTREP::ScoreBoard::ScoreBoard	(	const TravelQuery_T &	iQueryString,
		const ScoreType &	iType,
		const Score_T &	iScore
	)

Main constructor.

Definition at line 28 of file ScoreBoard.cpp.

References setScore().

OPENTREP::ScoreBoard::ScoreBoard ( const TravelQuery_T & iQueryString )

Default constructor.

Definition at line 17 of file ScoreBoard.cpp.

OPENTREP::ScoreBoard::ScoreBoard ( const ScoreBoard & iScoreBoard )

Copy constructor.

Definition at line 22 of file ScoreBoard.cpp.

OPENTREP::ScoreBoard::~ScoreBoard ( )

Default destructor.

Definition at line 35 of file ScoreBoard.cpp.

Member Function Documentation

const TravelQuery_T& OPENTREP::ScoreBoard::getQueryString ( ) const

inline

Get the query string.

Definition at line 36 of file ScoreBoard.hpp.

const ScoreMap_T& OPENTREP::ScoreBoard::getScoreMap ( ) const

inline

Get the map of scores.

Definition at line 43 of file ScoreBoard.hpp.

Score_T OPENTREP::ScoreBoard::getScore ( const ScoreType & iScoreType ) const

Get the score for the given type. If no score value has already been stored for that type, return 0.

Definition at line 40 of file ScoreBoard.cpp.

References OPENTREP::ScoreType::getType().

Referenced by OPENTREP::Result::displayXapianPercentages(), and getCombinedWeight().

Score_T OPENTREP::ScoreBoard::getCombinedWeight ( ) const

inline

Get the combined weight, if existing (0 otherwise).

Definition at line 56 of file ScoreBoard.hpp.

References OPENTREP::ScoreType::COMBINATION, and getScore().

void OPENTREP::ScoreBoard::setQueryString ( const TravelQuery_T & iQueryString )

inline

Set the query string.

Definition at line 66 of file ScoreBoard.hpp.

void OPENTREP::ScoreBoard::setScore	(	const ScoreType &	iScoreType,
		const Score_T &	iScore
	)

Set the score for the given type. If no score value has already been stored for that type, create it.

A trick is used to decrease the overall percentage of word combinations, when compared to the whole string. For instance, {"san francisco"} will have a percentage of 99.999%, compared to {"san", "francisco"} which will have a percentage of 99.998%.

A few rules are applied:

For matching with IATA/ICAO codes:
- When the query string fully matches with a IATA/ICAO code, the matching percentage is set to 100% (1.00).
- Otherwise, it is set to 99.999% (0.99999).
The Xapian matching weight is registered as is.
For envelope ID:
- When null, the score is taken as the full matching, i.e., 100% (1.00). There is no need to take 99.999%, as the Xapian matching value above already plays that role.
- When not null, the score is taken as the minimal default, i.e., 0.10% (0.001).