1. About AdvaS
2. Installation Guide
3. Usage Of AdvaS
4. Class AdvancedSearch
 -  4.1 __init__
 -  4.2 addEntry
 -  4.3 advancedSearch
 -  4.4 calculateRetrievalStatusValue
 -  4.5 clearEntryList
 -  4.6 compareDescriptors
 -  4.7 compareDescriptorsBinary
 -  4.8 compareDescriptorsFuzzy
 -  4.9 compareDescriptorsKNN
 -  4.10 comparePhoneticCode
 -  4.11 comparePhoneticCodeLists
 -  4.12 countEntryList
 -  4.13 extendStopList
 -  4.14 fullTextSearch
 -  4.15 getEmptyId
 -  4.16 getEntryList
 -  4.17 getSearchStrategy
 -  4.18 getSortOrder
 -  4.19 getStopList
 -  4.20 idf
 -  4.21 isInEntryList
 -  4.22 mergeLists
 -  4.23 mergeListsIdf
 -  4.24 reduceStopList
 -  4.25 removeEntry
 -  4.26 reverseSortOrder
 -  4.27 search
 -  4.28 searchByPhoneticCode
 -  4.29 setSearchStrategy
 -  4.30 setSortOrderAscending
 -  4.31 setSortOrderDescending
 -  4.32 setStopList
 -  4.33 sortEntryList
 -  4.34 tf
 -  4.35 tfStop
5. Class Advas
6. Class AdvasIo
7. Class Descriptors
8. Class Entry
9. Class Ngram
10. Class Phonetics
11. Class Stemmer
12. Information Retrieval Resources
13. Documentation
 
 calculateRetrievalStatusValue
 
calculateRetrievalStatusValue (self, d, p, q)

Added to advas-0.0.4 as funcrion calc_rsv, and renamed in advas-0.2.5.

Calculates the document weight for descriptors including their probability of existance. The method expects a list of pairs with 0 and 1, or as float values, accordingly.

In: d list of values displaying the existance (1) or non-existance (0) of a descriptor
  p list of probabilities of existance for the given descriptor d
  q list of probabilities of non-existance for the given descriptor d
     
Out:   Retrieval Status Value (rsv) as a float value. The higher the rsv, the more relevant is the document in terms of the given descriptor d, and their probabilities p and q. A value of 0 means that the document is non-relevant. In case the given lists differ in the number of elements, the return value is 0, too, because the rsv cannot be calculated properly.