有序集

有序集合和集合一样也是元素的集合,且不允许重复的成员。不同的是每个元素都会关联一个可以被排序的分数。

有序集合是通过分数来为集合中的成员进行从小到大的排序。有序集合的成员是唯一的,但分数却可以重复。

下面的示例代码中:abc/10表示TElement为abc,TSource为10

构造有序集

var sorset = new SortSet<string, int>();

函数原型

SortSet<TElement,TSource>(double probable = 0.25, int maxLevel = 32);

SortSet<TElement,TSource>(IComparer<TScore> comparer, double probable = 0.25, int maxLevel = 32);

Count

获取有序集中元素的数量。

var count = sorset.Count;

函数原型

int Count { get; }

SyncRoot

同步锁。

lock(sortset.SyncRoot)
{
}

函数原型

object SyncRoot { get; }

Clear

清空有序集

// [ "1/0", "2/1", "3/2"]
sortset.Clear();
// [ ]

函数原型

void Clear();

Add

添加一个元素到有序集合，或者如果它已经存在则更新其分数，并排序到正确的位置上。

// [ "1/0", "2/5", "3/10" ]
sortset.Add("abc", 3);
// [ "1/0", "abc/3", "2/5", "3/10" ]

函数原型

void Add(TElement element, TScore score);

Contains

判断有序集中是否存在指定元素。

// [ "a/0", "b/5", "c/10" ]
var exists = sortset.Contains("b");
// exists : true

函数原型

bool Contains(TElement element);

GetScore

返回有序集中指定元素的分数，如果元素不存在则引发KeyNotFoundException。

// [ "a/0", "b/5", "c/10" ]
var score = sortset.GetScore("b");
// score : 5

函数原型

TScore GetScore(TElement element);

GetRangeCount

获取分数区间内的元素数量。(包含min或max)

// [ "a/0", "b/10", "c/95", "d/101" ]
var num = sortset.GetRangeCount(10, 100);
// num : 2

函数原型

int GetRangeCount(TScore start, TScore end);

Remove

移除有序集合中的指定的元素，如果移除失败则返回false。

// [ "a/0", "b/10", "c/95", "d/101" ]
var result = sorset.Remove("c");
// result : true
// [ "a/0", "b/10", "d/101" ]

函数原型

bool Remove(TElement element);

RemoveRangeByRank

根据指定的排名范围移除范围内的所有元素，并返回移除元素的数量。(包含startRank或stopRank)

// [ "a/0", "b/10", "c/95", "d/101" ]
var count = sorset.RemoveRangeByRank(1, 2);
// count : 2
// [ "a/0", "d/101" ]

函数原型

int RemoveRangeByRank(int startRank, int stopRank);

RemoveRangeByScore

根据指定的分数范围移除范围内的所有元素，并返回移除元素的数量。(包含startScore或stopScore)

// [ "a/0", "b/10", "c/95", "d/101" ]
var count = sorset.RemoveRangeByRank(10, 100);
// count : 2
// [ "a/0", "d/101" ]

函数原型

int RemoveRangeByScore(TScore startScore, TScore stopScore);

GetRank

获取指定元素的排名 , 有序集成员默认按照Score从小到大排序（如果自定义比较函数则按照自定义比较函数顺序为主）。如果返回-1则表示没有找到元素。

// [ "a/0", "b/10", "c/95", "d/101" ]
var rank = sorset.GetRank("c");
// rank : 2

函数原型

int GetRank(TElement element);

GetRevRank

获取指定元素的反向排名 , 有序集成员默认按照Score从大到小排序（如果自定义比较函数则按照自定义比较函数的反向顺序为主）。如果返回-1则表示没有找到元素。

// [ "a/0", "b/10", "c/95", "d/101" ]
var rank = sorset.GetRevRank("c");
// rank : 1

函数原型

int GetRevRank(TElement element);

GetElementRangeByRank

根据排名获取范围内的元素列表，排序按照排名从小到大（给定自定义比较函数则按照自定义比较函数顺序）。(包含startRank或stopRank)

// [ "a/0", "b/10", "c/95", "d/101" ]
var elements = sorset.GetElementRangeByRank(1, 2);
// elements[0] : "b/10"
// elements[1] : "c/95"

函数原型

TElement[] GetElementRangeByRank(int startRank, int stopRank);

GetElementRangeByScore

根据分数获取范围内的元素列表，排序按照排名从小到大（给定自定义比较函数则按照自定义比较函数顺序）。(包含startScore或stopScore)

// [ "a/0", "b/10", "c/95", "d/101" ]
var elements = sorset.GetElementRangeByScore(10, 100);
// elements[0] : "b/10"
// elements[1] : "c/95"

函数原型

TElement[] GetElementRangeByScore(TScore startScore, TScore stopScore);

GetElementByRank

根据排名获取元素，排序按照排名从小到大（给定自定义比较函数则按照自定义比较函数顺序）

// [ "a/0", "b/10", "c/95", "d/101" ]
var element = sorset.GetElementByRank(2);
// element : "c/95"

函数原型

TElement GetElementByRank(int rank);

GetElementByRevRank

根据排名获取元素，排序按照排名从大到小（给定自定义比较函数则按照自定义比较函数的相反顺序）

// [ "a/0", "b/10", "c/95", "d/101" ]
var element = sorset.GetElementByRevRank(2);
// element : "b/10"

函数原型

TElement GetElementByRevRank(int rank);

GetIterator

获取迭代器，需要传入一个值决定是否是前序遍历。

// 物理顺序：[ "a/0", "b/10", "c/95", "d/101" ]
// foreach顺序：[ "a/0", "b/10", "c/95", "d/101" ]
sorset.GetIterator();

// 物理顺序：[ "a/0", "b/10", "c/95", "d/101" ]
// foreach顺序：[ "d/101", "c/95", "b/10", "a/0" ]
sorset.GetIterator(false);

函数原型

void GetIterator(bool forward = true);

First

获取第一个元素。

// [ "a/0", "b/10", "c/95", "d/101" ]
var element = sorset.First();
// element : "a/0"

函数原型

TElement First();

Last

获取最后一个元素。

// [ "a/0", "b/10", "c/95", "d/101" ]
var element = sorset.Last();
// element : "d/101"

函数原型

TElement Last();

Shift

移除并返回有序集头部的元素。

// [ "a/0", "b/10", "c/95", "d/101" ]
var element = sorset.Shift();
// element : "a/0"
// [ "b/10", "c/95", "d/101" ]

函数原型

TElement Shift();

Pop

移除并返回有序集尾部的元素。

// [ "a/0", "b/10", "c/95", "d/101" ]
var element = sorset.Pop();
// element : "d/101"
// [ "a/0", "b/10", "c/95" ]

函数原型

TElement Pop();

this[int]

获取指定排名的元素。

// [ "a/0", "b/10", "c/95", "d/101" ]
var element = sorset[2];
// element : "b/10"

函数原型

TElement this[int rank] { get; }

ToArray

将有序集转为数组。

// [ "a/0", "b/10", "c/95", "d/101" ]
var elements = sorset.ToArray();
// elements : [ "a", "b", "c", "d" ]

函数原型

TElement[] ToArray();