一种对象集合,这些对象可以相互排序。
此集合基于自平衡二叉树。它允许大多数操作在摊销对数时间内完成。
集合的元素通过构造函数中传入的compare
函数进行比较,用于排序和等价性。如果集合只包含一个对象a
,则只有当compare(a, b) == 0
时,set.contains(b)
将返回true
,并且不检查*a* 是否等于*b* 的值。如果省略比较函数,假定对象是Comparable,并且使用它们的Comparable.compareTo方法进行比较。非可比对象(包括null
)在这种情况下将无法作为元素。
注意:在执行操作(例如在forEach或containsAll调用期间调用的函数)时,不要修改集合(添加或删除元素),或者在迭代集合时。
在元素位于集合中时,不要以改变它们的等价性(从而改变它们的哈希码)的方式修改它们。某些专门的集合类型可能对等价性更加宽容,在这种情况下,它们应该记录它们不同的行为和限制。
示例
final planets = SplayTreeSet<String>((a, b) => a.compareTo(b));
planets.add('Neptune');
planets.addAll({'Venus', 'Mars', 'Earth', 'Jupiter'});
print(planets); // {Earth, Jupiter, Mars, Neptune, Venus}
要检查集合是否为空,请使用isEmpty或isNotEmpty。要查找集合中的元素数量,请使用length。
final isEmpty = planets.isEmpty; // false
final length = planets.length; // 5
要检查集合是否包含特定元素,请使用contains。
final marsExists = planets.contains('Mars'); // true
要使用索引获取元素值,请使用elementAt。
final elementAt = planets.elementAt(1);
print(elementAt); // Jupiter
要复制集合,请使用toSet。
final copySet = planets.toSet(); // a `SplayTreeSet` with the same ordering.
print(copySet); // {Earth, Jupiter, Mars, Neptune, Venus}
要删除元素,请使用remove。
final removedValue = planets.remove('Mars'); // true
print(planets); // {Earth, Jupiter, Neptune, Venus}
要同时删除多个元素,请使用removeWhere。
planets.removeWhere((element) => element.startsWith('J'));
print(planets); // {Earth, Neptune, Venus}
要删除不满足条件的所有元素,请使用retainWhere。
planets.retainWhere((element) => element.contains('Earth'));
print(planets); // {Earth}
要删除所有元素并清空集合,请使用clear。
planets.clear();
print(planets.isEmpty); // true
print(planets); // {}
另请参阅
- Set是对象集合的基类。
- HashSet不保证对象在迭代中的顺序。
- LinkedHashSet基于插入顺序存储对象。
- 混合类型
- 可用的扩展
构造函数
- SplayTreeSet([int compare(E key1, E key2)?, bool isValidKey(dynamic potentialKey)?])
- 使用指定的比较函数创建一个新的SplayTreeSet。
- SplayTreeSet.from(Iterable elements, [int compare(E key1, E key2)?, bool isValidKey(dynamic potentialKey)?])
- 创建一个包含所有
elements
的 SplayTreeSet。工厂 -
SplayTreeSet.of(Iterable<
E> elements, [int compare(E key1, E key2)?, bool isValidKey(dynamic potentialKey)?]) - 从
elements
创建一个 SplayTreeSet。工厂
属性
- first → E
- 第一个元素。没有设置器重写
- hashCode → int
- 此对象的哈希码。没有设置器继承
- isEmpty → bool
- 此集合是否没有元素。没有设置器重写
- isNotEmpty → bool
- 此集合是否有至少一个元素。没有设置器重写
-
iterator → Iterator<
E> - 一个新
Iterator
,允许遍历此Iterable
的元素。没有设置器重写 - last → E
- 最后一个元素。没有设置器重写
- length → int
- 此 中元素的数量。没有设置器重写
- runtimeType → Type
- 对象的运行时类型的表示。没有设置器继承
- single → E
- 检查此可迭代是否只有一个元素,并返回该元素。没有设置器重写
方法
-
add(
E element) → bool - 将
value
添加到集合中。重写 -
addAll(
Iterable< E> elements) → void - 将所有
elements
添加到此集合中。重写 -
any(
bool test(E element)) → bool - 检查此可迭代对象中的任何元素是否满足
test
.继承 -
cast<
R> () → Set< R> - 将此可迭代对象视为
R
实例的可迭代对象视图。重写 -
clear(
) → void - 从集合中删除所有元素。重写
-
contains(
Object? element) → bool - 集合是否包含与
element
相等的元素。重写 -
containsAll(
Iterable< Object?> other) → bool - 此集合是否包含
other
中的所有元素。继承 -
difference(
Set< Object?> other) → Set<E> - 创建一个新集合,包含此集合中不在
other
中的元素。重写 -
elementAt(
int index) → E - 返回第
index
个元素。继承 -
every(
bool f(E element)) → bool - 检查此可迭代对象中的每个元素是否满足
test
。继承 -
expand<
T> (Iterable< T> f(E element)) → Iterable<T> - 将此可迭代对象的每个元素扩展为零或多个元素。继承
-
firstWhere(
bool test(E value), {E orElse()?}) → E - 满足给定谓词
test
的第一个元素。继承 -
fold<
T> (T initialValue, T combine(T previousValue, E element)) → T - 通过迭代将集合中的每个元素与现有值结合,将集合减少到单一值。继承
-
followedBy(
Iterable< E> other) → Iterable<E> - 创建了一个惰性连接,将此可迭代对象与
other
连接。继承 -
forEach(
void f(E element)) → void - 在迭代顺序中调用
action
于此可迭代对象的每个元素。继承 -
intersection(
Set< Object?> other) → Set<E> - 创建一个新的集合,它是此集合与
other
的交集。重写 -
join(
[String separator = ""]) → String - 将每个元素转换为String并连接字符串。继承
-
lastWhere(
bool test(E value), {E orElse()?}) → E - 最后一个满足给定谓词
test
的元素。继承 -
lookup(
Object? object) → E? - 如果在集合中存在与
object
相等的对象,则返回它。重写 -
map<
T> (T f(E element)) → Iterable< T> - 通过
toElement
修改此可迭代对象的当前元素。继承 -
noSuchMethod(
Invocation invocation) → dynamic - 当访问不存在的方法或属性时将被调用。继承
-
reduce(
E combine(E value, E element)) → E - 通过迭代结合集合的元素,将集合缩减为一个单一值。继承
-
remove(
Object? object) → bool - 从集合中移除
value
。重写 -
removeAll(
Iterable< Object?> elements) → void - 从该集合中移除
elements
中的每个元素。重写 -
removeWhere(
bool test(E element)) → void - 移除满足
test
条件的所有元素。继承 -
retainAll(
Iterable< Object?> elements) → void - 移除不在
elements
中的所有元素。重写 -
retainWhere(
bool test(E element)) → void - 移除不满足
test
条件的所有元素。继承 -
singleWhere(
bool test(E value), {E orElse()?}) → E - 满足
test
条件的单一元素。继承 -
skip(
int n) → Iterable< E> - 创建一个 Iterable,提供排除前
count
个元素的所有元素。继承 -
skipWhile(
bool test(E value)) → Iterable< E> - 创建一个
Iterable
,当test
为真时跳过开始元素。继承 -
take(
int n) → Iterable< E> - 创建一个惰性可迭代对象,包含此可迭代对象的前
count
个元素。继承 -
takeWhile(
bool test(E value)) → Iterable< E> - 创建一个惰性可迭代对象,包含满足
test
的前几个元素。继承 -
toList(
{bool growable = true}) → List< E> - 创建一个包含此可迭代对象元素的List。继承
-
toSet(
) → Set< E> - 创建一个包含此可迭代对象相同元素的Set。重写
-
toString(
) → String - 此对象的字符串表示形式。重写
-
union(
Set< E> other) → Set<E> - 创建一个新集合,包含此集合和
other
的所有元素。重写 -
where(
bool f(E element)) → Iterable< E> - 创建一个新的惰性Iterable,包含所有满足谓词
test
的元素。继承 -
whereType<
T> () → Iterable< T> - 创建一个新的惰性Iterable,包含所有类型为
T
的元素。继承
操作符
-
operator ==(
Object other) → bool - 等号操作符。继承