https://github.com/amalloy/ordered

Ordered sets and maps, implemented in pure clojure
https://github.com/amalloy/ordered

Last synced: 3 months ago
JSON representation

Ordered sets and maps, implemented in pure clojure

• Host: GitHub
• URL: https://github.com/amalloy/ordered
• Owner: clj-commons
• License: epl-1.0
• Created: 2011-06-20T17:43:45.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2024-05-13T19:13:34.000Z (6 months ago)
• Last Synced: 2024-05-19T05:03:21.532Z (6 months ago)
• Language: Clojure
• Homepage:
• Size: 209 KB
• Stars: 256
• Watchers: 9
• Forks: 40
• Open Issues: 8
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE
  • Codeowners: .github/CODEOWNERS

Awesome Lists containing this project

• awesome-clojure - Ordered

README

        
[![Clojars Project](https://img.shields.io/clojars/v/org.flatland/ordered.svg)](https://clojars.org/org.flatland/ordered)

[![cljdoc badge](https://cljdoc.org/badge/org.flatland/ordered)](https://cljdoc.org/d/org.flatland/ordered/CURRENT)

[![CircleCI Status](https://circleci.com/gh/clj-commons/ordered.svg?style=svg)](https://circleci.com/gh/clj-commons/ordered)

ordered provides sets and maps that maintain the insertion order of their contents.

## Sets

```clojure

(use 'flatland.ordered.set)

(ordered-set 4 3 1 8 2)

=> #ordered/set (4 3 1 8 2)

(conj (ordered-set 9 10) 1 2 3)

=> #ordered/set (9 10 1 2 3)

(into (ordered-set) [7 6 1 5 6])

=> #ordered/set (7 6 1 5)

(disj (ordered-set 8 1 7 2 6) 7)

=> #ordered/set (8 1 2 6)

;; Adding an element already in an ordered set does not change its

;; position in the order.

(conj (ordered-set 4 3 1 8 2) 8)

=> #ordered/set (4 3 1 8 2)

;; Removing an element, then adding it back in, puts it at the end,

;; just as it would if it were never part of the set.

(-> (ordered-set 4 3 1 8 2) (disj 8) (conj 8))

=> #ordered/set (4 3 1 2 8)

```

## Maps

```clojure

(use 'flatland.ordered.map)

(ordered-map :b 2 :a 1 :d 4)

=> #ordered/map ([:b 2] [:a 1] [:d 4])

(assoc (ordered-map :b 2 :a 1 :d 4) :c 3)

=> #ordered/map ([:b 2] [:a 1] [:d 4] [:c 3])

(into (ordered-map) [[:c 3] [:a 1] [:d 4]])

=> #ordered/map ([:c 3] [:a 1] [:d 4])

(dissoc (ordered-map :c 3 :a 1 :d 4) :a)

=> #ordered/map ([:c 3] [:d 4])

;; Adding a key already in an ordered map does not change its position

;; in the order.

(assoc (ordered-map :b 2 :a 1 :d 4) :b 7)

=> #ordered/map ([:b 7] [:a 1] [:d 4])

;; Removing a key, then adding it back in, puts it at the end, just as

;; it would if it were never part of the map.

(-> (ordered-map :b 2 :a 1 :d 4) (dissoc :b) (assoc :b 7))

=> #ordered/map ([:a 1] [:d 4] [:b 7])

```

## History

ordered was originally created by [Alan Malloy](https://github.com/amalloy) and was part of the [flatland](https://github.com/flatland) organisation. In December 2018 it was moved to CLJ Commons for continued maintenance.

It could previously be found at [amalloy/ordered](https://github.com/amalloy/ordered) and [flatland/ordered](https://github.com/flatland/ordered). [clj-commons/ordered](https://github.com/clj-commons/ordered) is the canonical repository now.