Opened 14 years ago

Closed 13 years ago

#254 closed request (fixed)

Document distance, euclidean_distance, ...

Reported by: Peter Owned by: Markus Ringnér
Priority: minor Milestone: yat 0.4
Component: documentation Version: trunk
Keywords: Cc:

Description


Change History (7)

comment:1 Changed 13 years ago by Markus Ringnér

Could someone please be more concrete regarding what is lacking in the current documentation.

comment:2 Changed 13 years ago by Markus Ringnér

  • I guess what is missing is how-to-use documentation for the top-level functions supposed to be called by users?
  • More low-level documentation helping to code additional distance measures is that needed too? Or are the current descriptions sufficient?

comment:3 Changed 13 years ago by Markus Ringnér

Summary: Document vector_distancesDocument distance, euclidean_distance, ...

comment:4 Changed 13 years ago by Peter

The docs need to be updated. In euclidean_distance, e.g., it says that function only works on random access iterators. I think it works on List::iterators as well.

Also it would be nice to provide an expression on what is returned.

comment:5 Changed 13 years ago by Peter

some docs for EuclideanDistance? in [1093]

comment:6 Changed 13 years ago by Markus Ringnér

Owner: changed from Peter to Markus Ringnér

comment:7 Changed 13 years ago by Markus Ringnér

Resolution: fixed
Status: newclosed
Note: See TracTickets for help on using tickets.