Contains a SortedMap and FilteredMap class, which hold a map of objects that can be ordered relative to each other.

Unlike SplayTreeMap the objects can be ordered on both key and value or a combination of both.

The FilteredMap also allows to specify an isValid function on key/value pairs and limit the number of objects allowed in the map.

SortedMap #

A simple usage example:

import 'package:sortedmap/sortedmap.dart';

main() {
  var map = new SortedMap((Pair a, Pair b)=>Comparable.compare(a.value, b.value));
  
  map.addAll({
    "a": 3,
    "b": 2,
    "c": 4,
    "d": 1
  });
  
  print(map.lastKeyBefore("c")); // a
  print(map.firstKeyAfter("d")); // b
  
}

FilteredMap #

A simple usage example:

import 'package:sortedmap/sortedmap.dart';

main() {
  var map = new FilteredMap(new Filter(
    compare: (Pair a, Pair b)=>Comparable.compare(a.value, b.value),
    isValid: (Pair v) => v.key!="b",
    limit: 2));
  
  map.addAll({
    "a": 3,
    "b": 2,
    "c": 4,
    "d": 1
  });
  
  print(map.keys); // (d, a)
  
}

Features and bugs #

Please file feature requests and bugs at the issue tracker.

Changelog #

0.4.2 #

Support Dart 2 in pubspec.yaml

0.4.1 #

fixes on Dart 2 compatibility

0.4.0 #

Dart 2 pre-release compatibility

0.3.1 #

performance improvements

0.3.0 #

resolve strong mode analysis warnings
change dependency on quiver to <0.28.0

0.2.0 #

new FilteredMapView class
some api changes

0.1.2 #

keep elements after limit in FilteredMap

0.1.1 #

compare and isValid methods iso getters in Filter
strong mode fixes
linter

0.1.0 #

Initial version

Use this package as a library

1. Depend on it

Add this to your package's pubspec.yaml file:


dependencies:
  sortedmap: ^0.4.2

2. Install it

You can install packages from the command line:

with pub:


$ pub get

with Flutter:


$ flutter pub get

Alternatively, your editor might support pub get or flutter pub get. Check the docs for your editor to learn more.

3. Import it

Now in your Dart code, you can use:


import 'package:sortedmap/sortedmap.dart';

Version	Uploaded	Documentation	Archive
0.4.2	Aug 14, 2018
0.4.1	Jul 18, 2018
0.4.0	Jul 12, 2018
0.3.1	Jul 12, 2018
0.3.0	Mar 19, 2018
0.2.0	Mar 7, 2017
0.1.2	Feb 10, 2017
0.1.1	Jun 17, 2016
0.1.0	Jun 7, 2016

Popularity: Describes how popular the package is relative to other packages. [more]	79
Health: Code health derived from static analysis. [more]	87
Maintenance: Reflects how tidy and up-to-date the package is. [more]	90
Overall: Weighted score of the above. [more]	84

Learn more about scoring.

We analyzed this package on Jun 4, 2019, and provided a score, details, and suggestions below. Analysis was completed with status completed using:

Dart: 2.3.1
pana: 0.12.17

Platforms

Detected platforms: Flutter, web, other

No platform restriction found in primary library package:sortedmap/sortedmap.dart.

Health suggestions

Fix lib/src/treeset.dart. (-6.78 points)

Analysis of lib/src/treeset.dart reported 14 hints, including:

line 19 col 21: Use = to separate a named parameter from its default value.

line 19 col 44: Use = to separate a named parameter from its default value.

line 306 col 65: Use = to separate a named parameter from its default value.

line 306 col 88: Use = to separate a named parameter from its default value.

line 560 col 54: Use = to separate a named parameter from its default value.

Fix lib/src/sortedmap.dart. (-3.45 points)

Analysis of lib/src/sortedmap.dart reported 7 hints, including:

line 32 col 24: Use = to separate a named parameter from its default value.

line 92 col 20: Use = to separate a named parameter from its default value.

line 99 col 24: Use = to separate a named parameter from its default value.

line 108 col 24: Use = to separate a named parameter from its default value.

line 181 col 48: DO use curly braces for all flow control structures.

Fix lib/src/filter.dart. (-1.49 points)

Analysis of lib/src/filter.dart reported 3 hints:

line 32 col 21: Use = to separate a named parameter from its default value.

line 34 col 20: Use = to separate a named parameter from its default value.

line 35 col 25: Use = to separate a named parameter from its default value.

Fix additional 4 files with analysis or formatting issues. (-1.99 points)

Additional issues in the following files:

lib/src/filteredmap.dart (3 hints)
lib/src/treemap.dart (1 hint)
lib/sortedmap.dart (Run dartfmt to format lib/sortedmap.dart.)
lib/src/ordering.dart (Run dartfmt to format lib/src/ordering.dart.)

Maintenance suggestions

Maintain an example. (-10 points)

Create a short demo in the example/ directory to show how to use this package.

Common filename patterns include main.dart, example.dart, and sortedmap.dart. Packages with multiple examples should provide example/README.md.

For more information see the pub package layout conventions.

Dependencies

Package	Constraint	Resolved
Direct dependencies
Dart SDK	>=1.14.0 <3.0.0
quiver	>=0.22.0 <3.0.0	2.0.3
Transitive dependencies
matcher		0.12.5
meta		1.1.7
path		1.6.2
stack_trace		1.9.3
Dev dependencies
benchmark_harness	^1.0.4
test	>=0.12.0 <2.0.0

Dart pub

sortedmap 0.4.2