diff options
Diffstat (limited to 'lib/stdlib/doc/src/file_sorter.xml')
-rw-r--r-- | lib/stdlib/doc/src/file_sorter.xml | 14 |
1 files changed, 8 insertions, 6 deletions
diff --git a/lib/stdlib/doc/src/file_sorter.xml b/lib/stdlib/doc/src/file_sorter.xml index b3f4da294c..ccb32659a0 100644 --- a/lib/stdlib/doc/src/file_sorter.xml +++ b/lib/stdlib/doc/src/file_sorter.xml @@ -4,7 +4,7 @@ <erlref> <header> <copyright> - <year>2001</year><year>2009</year> + <year>2001</year><year>2010</year> <holder>Ericsson AB. All Rights Reserved.</holder> </copyright> <legalnotice> @@ -13,12 +13,12 @@ compliance with the License. You should have received a copy of the Erlang Public License along with this software. If not, it can be retrieved online at http://www.erlang.org/. - + Software distributed under the License is distributed on an "AS IS" basis, WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License for the specific language governing rights and limitations under the License. - + </legalnotice> <title>file_sorter</title> @@ -83,13 +83,15 @@ An ordering function is antisymmetric, transitive and total. <c>Fun(A, B)</c> should return <c>true</c> if <c>A</c> comes before <c>B</c> in the ordering, <c>false</c> otherwise. + An example of a typical ordering function is less than or equal + to, <c>=</2</c>. Using an ordering function will slow down the sort considerably. The <c>keysort</c>, <c>keymerge</c> and <c>keycheck</c> functions do not accept ordering functions. </item> <item><c>{unique, bool()}</c>. When sorting or merging files, - only the first of a sequence of terms that compare equal is - output if this option is set to <c>true</c>. The default + only the first of a sequence of terms that compare equal (<c>==</c>) + is output if this option is set to <c>true</c>. The default value is <c>false</c> which implies that all terms that compare equal are output. When checking files for sortedness, a check that no pair of consecutive terms @@ -301,7 +303,7 @@ Value = Term</pre> <desc> <p>Sorts tuples on files. The sort is performed on the element(s) mentioned in <c>KeyPos</c>. If two tuples - compare equal on one element, next element according to + compare equal (<c>==</c>) on one element, next element according to <c>KeyPos</c> is compared. The sort is stable. </p> <p><c>keysort(N, FileName)</c> is equivalent to |