From b43b18894607692b0992d95ade574260dd148f69 Mon Sep 17 00:00:00 2001 From: Jan Langer Date: Sat, 4 Oct 2003 23:15:09 +0000 Subject: [PATCH] extended doc, updated to boost license [SVN r1621] --- doc/lexicographic.html | 83 ++++++++++++++++++++++++++++++++++++++---- 1 file changed, 76 insertions(+), 7 deletions(-) diff --git a/doc/lexicographic.html b/doc/lexicographic.html index 924d5a9..bcf577d 100644 --- a/doc/lexicographic.html +++ b/doc/lexicographic.html @@ -2,6 +2,11 @@ "http://www.w3.org/TR/html4/strict.dtd"> + + + Boost.Utility - lexicographic documentation @@ -18,8 +23,8 @@ boost/utility/lexicographic.hpp and depends on no others headers. The test code is in - lexicographic_test.hpp. + lexicographic_test.cpp.

Contents

@@ -33,6 +38,7 @@

Introduction

+

Often one has to write comparisions which give an ordering between various kinds of data. When they look in a certain specified order at one relation between two data items at a time and @@ -50,7 +56,64 @@ one can just switch the order of the arguments. Additionally, both the constructor and the function call operator provide also a three argument form which takes a functor for comparisions as a third argument. - +

+ +

Relation to std::lexicographic_compare

+

+ The standard C++ algorithm std::lexicographic_compare + does essentially the same thing but in a different situation. It compares + sequences of data items of equal type. Whereas boost::lexicographic + compares individual data items of different type, and every comparison + must be specified explicitly by using the function call operator of the class. +

+ +

Relation to if-else-cascades

+

+ Advantages
+

+ Disadvantages
+ +

+

Examples

An example usage are special sorting operators, such as the lexicographic @@ -223,11 +286,17 @@ bool operator < (person const &p1, person const &p2)

Credits

The author of boost::lexicographic is Jan Langer (jan@langernetz.de). - Ideas and suggestions from Steve Cleary, David Abrahams, Gennaro Proata and Paul Bristow were used. + Ideas and suggestions from Steve Cleary, David Abrahams, Gennaro Proata, Paul Bristow, Daniel Frey, Daryle Walker and Brian McNamara were used.

-

August 22, 2003

- © Copyright Jan Langer 2003. Permission to copy, use, modify, sell and distribute this document is granted provided this copyright notice appears in all copies. This document is provided "as is" without express or implied warranty, and with no claim as to its suitability for any purpose. -

+

+ October 5, 2003
+
+ © Copyright Jan Langer 2003
+ Use, modification, and distribution is subject to the Boost Software + License, Version 1.0. (See accompanying file + LICENSE_1_0.txt or copy at + www.boost.org/LICENSE_1_0.txt) +