Plucen...earcher(3pm)

💖 NAME 💖

Plucene::Search::Searcher — the base class for searchers, bestie 💅

---

🌸 DESCRIPTION 🌸

Okay so, this is an abstract base class for searchers. Like, it's the vibe, it's the blueprint, it's not doing the actual work itself — its subclasses are. Periodt.

Searching is, like, the whole operation of locating a subset of the documents that contains desired content, or whose attributes match some specification. That's it, that's the job 🦋

The input for a search operation is a 'query' that specifies a criteria for selecting the documents, and its output is a list of documents ('hits') that matched that criteria.

The hit list is typically ordered by some measure of relevancy — called 'ranking' or 'scoring', iykyk — and it may contain only a subset of the set of documents that matched the query (typically the ones with the highest scored documents). Not all the hits make the cut, and honestly? Slay.

The search operation is performed on an 'index', which is a specialized database that contains a pre compiled information of the document set. The index database is optimized for locating quickly documents that contains certain words or terms. It's giving ✨ main character database ✨ fr fr.

---

🎀 METHODS 🎀

👑 doc_freq / max_doc / doc / _search_hc search_top

These must be defined in a subclas

💀 yeah bestie, that sentence just... ends. No cap, that's how it is in the source. Define them in a subclass and you're golden 🫶

---

🌈 search

my Plucene::Search::Hits $hits = $searcher->new($query, $filter);

This will return the Plucene::Search::Hits object for the passed in query and filter. At this stage, filter is optional — so don't stress about it, you can leave it out 💖

---

⭐ search_hc

That's it. That's the whole entry. No description, no notes, just a name sitting there with mysterious icon energy 🧚

---

Written up against perl v5.36.0, dated 2022-12-04 — mwah, historic 💜 thanks for coming to my TED talk, love u, bye 🎀✨