blob: 026e66ff04342227486b7a090318b0ba2b97b9b9 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
|
/**
* Copyright (c) David Miller. All rights reserved.
* The use and distribution terms for this software are covered by the
* Eclipse Public License 1.0 (http://opensource.org/licenses/eclipse-1.0.php)
* which can be found in the file epl-v10.html at the root of this distribution.
* By using this software in any fashion, you are agreeing to be bound by
* the terms of this license.
* You must not remove this notice, or any other, from this software.
**/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Collections;
namespace clojure.lang
{
/// <summary>
/// Represents an immutable collection that is sorted.
/// </summary>
/// <remarks>
/// <para>Lowercase-named methods for compatibility with the JVM implementation.</para>
/// </remarks>
public interface Sorted
{
/// <summary>
/// Returns the comparer used to sort the elements in the collection.
/// </summary>
/// <returns>The <c>IComparer</c> used to sort the items.</returns>
/// <remarks>Would be called <c>Comparer</c> except we need to match the JVM name.</remarks>
IComparer comparator();
/// <summary>
/// Returns the key to be passed to the comparator to sort the element.
/// </summary>
/// <param name="entry">An element in the collection.</param>
/// <returns>The key used to sort the element.</returns>
object entryKey(object entry);
/// <summary>
/// Returns an <see cref="ISeq">ISeq</see> to iterate through the collection in the designated direction.
/// </summary>
/// <param name="ascending">A flag indicating if the iteration is ascending or descending.</param>
/// <returns>A sequence for first/rest iteration.</returns>
ISeq seq(bool ascending);
/// <summary>
/// Returns an <see cref="ISeq">ISeq</see> to iterate through the collection in the designated direction starting from a particular key.
/// </summary>
/// <param name="key">The key at which to start the iteration.</param>
/// <param name="ascending">A flag indicating if the iteration is ascending or descending.</param>
/// <returns>A sequence for first/rest iteration.</returns>
/// <remarks>The key need not be in the collection. If not present, the iteration will start with
/// the first element with a key greater than (if asscending) or less than (if descending) the given key.</remarks>
ISeq seqFrom(object key, bool ascending);
}
}
|
