nklein software

Track-Best is a Common Lisp library used to track the N best of some
series of items. One creates a tracker and then adds scored items to
it. The tracker keeps the N best items and returns them at the end.

Accessing

• Main git repository: http://git.nklein.com/lisp/libs/track-best.git
• Browsable repository: https://github.com/nklein/track-best

Usage

The main entry point is the function WITH-TRACK-BEST macro.

The body can call (track item score &optional tracker) as often as
desired. In the end, the with-track-best will return two values:
the list of best items and the list of their scores.

The keyword-args can be any of the following:

• :NAME variable-name — A symbol used as the variable name for the
  tracker. This is only needed if you will explicitly refer to the
  tracker in the body statements.
• :KEEP number-to-keep — The number of items to track. This
  defaults to 1 item.
• :KEEP-TIES whether-to-keep-ties — If true, then items with the same score will all be kept until there are KEEP items with better
  scores. This defaults to NIL.
• :ORDER-BY-FN function-to-compare-scores — The function used to
  determine if one score is larger or smaller than another score. The
  default for this argument is #'>
• :ALWAYS-RETURN-LIST t-or-nil — If always-return-list is true, then WITH-TRACK-BEST will return a list even when KEEP is 1. If always-return-list is not true, then WITH-TRACK-BEST will return the single item when KEEP is 1. The default for this argument is NIL.
• :RETURN-BEST t-or-nil — if return-best is NIL, then the form
  returns the value(s) from the last expression in the body rather
  than the best items. This argument defaults to T. Note: This
  argument is evaluated at macroexpansion time, not at runtime.

The other useful entry point is the MAP-BEST which takes a function and an optional tracker. It calls the function for each item currently in the best list of the tracker (from best to worst). MAP-BEST passes two parameters to the function: the item and its score. The MAP-BEST function returns a list of the results of those function calls.

Example: Finding the longest matching substring in two strings

Given two strings S1 and S2, find the longest substring they have
in common.

The outer DOTIMES loop determines the length substring of S1 to
look for in S2. The inner DOTIMES loop picks the offset to start
the substring of S1. Then, if the substring is found in S2, it is
tracked with its score being its length.

Example: Finding the farthest vertex from a point

Given a list of vertexes VERTEX-LIST, find the vertex farthest from
a TARGET vertex based on a given DISTANCE function.

Example: Finding the three closest vertexes to a point

Given a list of vertexes VERTEX-LIST, find the three that are closest
to a TARGET vertex based on a given DISTANCE function.

The :ORDER-BY-FN function here specifies that the best vectors are
the ones with the smallest score. The scores used here are the
distance from the TARGET as given by the DISTANCE-FN.

Example: The lowest highest point

Suppose you had a list of various states. For each state you had a
list of different cities and their altitude. Find the highest
altitude in each state and find the state with the lowest high.

The inner DOLIST here tracks the highest city in a given state. The
outer DOLIST trackes the lowest of the highest cities.

Example: Finding the lowest and highest numbers in a list

Given a list of numbers, return a list containing the lowest number
and highest number from the list.

In this example, we used the :NAME to specify two different
trackers. In our loop, we tracked each value with both trackers. In
the end, we also used the :RETURN-RESULTS NIL directive so that the
returned value would be our LIST expression rather than the best
result from the LOWEST tracker.

Example: Keeping ties

If the :KEEP-TIES parameter is not NIL, then all items with the best
score will be returned. The order of these items is not guaranteed.

Warning about how ties are handled

If the :KEEP parameter is 1, the first item tracked with the best
score will be returned. If the :KEEP parameter is greater than one,
there is no guarantee about which items are kept when multiple items
of the same score are found. For example, the following form will
definitely return (VALUES :EIGHT 8).

On the other hand, this snippet will not guarantee the order in which
:EIGHT, :OCHO, and :HUIT appear nor which of :FIVE, :CINQO,
or :CINQ will be included.

To be sure, the answer is deterministic. Given the same inputs in the
same order, the same output will be generated. There are two caveats
to this:

• Where a tie gets inserted amongst its peers is highly sensitive to
  the number of items being kept and where its peers are in the list
  at the time of insertion.
• More importantly, I make no guarantee that this order will be
  preserved across releases. You should not depend on particular
  behavior when :KEEP is greater than one.