Panduan untuk TreeSet di Java

1. Ikhtisar

Pada artikel ini, kita akan melihat bagian integral dari Java Collections Framework dan salah satu implementasi Set paling populer - TreeSet .

2. Pendahuluan TreeSet

Sederhananya, TreeSet adalah koleksi terurut yang memperluas kelas AbstractSet dan mengimplementasikan antarmuka NavigableSet .

Berikut ringkasan singkat dari aspek terpenting dari penerapan ini:

  • Ini menyimpan elemen unik
  • Itu tidak mempertahankan urutan penyisipan elemen
  • Ini mengurutkan elemen dalam urutan menaik
  • Ini tidak aman untuk benang

Dalam implementasi ini, objek diurutkan dan disimpan dalam urutan menaik menurut urutan aslinya . The TreeSet menggunakan pohon pencarian biner self-balancing, lebih khusus Red-Black pohon.

Sederhananya, sebagai pohon pencarian biner yang menyeimbangkan diri, setiap simpul dari pohon biner terdiri dari bit ekstra, yang digunakan untuk mengidentifikasi warna simpul yang merah atau hitam. Selama penyisipan dan penghapusan berikutnya, bit "warna" ini membantu memastikan bahwa pohon tetap lebih atau kurang seimbang.

Jadi, mari buat instance TreeSet :

Set treeSet = new TreeSet();

2.1. TreeSet Dengan Parameter Pembanding Konstruktor

Secara opsional, kita bisa membuat TreeSet dengan konstruktor yang memungkinkan kita menentukan urutan elemen yang diurutkan dengan menggunakan Comparable atau Comparator:

Set treeSet = new TreeSet(Comparator.comparing(String::length));

Meskipun TreeSet tidak aman untuk thread, ia dapat disinkronkan secara eksternal menggunakan pembungkus Collections.synchronizedSet () :

Set syncTreeSet = Collections.synchronizedSet(treeSet);

Baiklah, sekarang kita memiliki ide yang jelas tentang cara membuat instance TreeSet , mari kita lihat operasi umum yang kita miliki.

3. TreeSet add ()

Metode add () , seperti yang diharapkan, bisa digunakan untuk menambahkan elemen ke TreeSet . Jika sebuah elemen ditambahkan, metode akan mengembalikan nilai true, jika tidak - false.

Kontrak metode menyatakan bahwa elemen akan ditambahkan hanya jika elemen yang sama belum ada di Set .

Mari tambahkan elemen ke TreeSet :

@Test public void whenAddingElement_shouldAddElement() { Set treeSet = new TreeSet(); assertTrue(treeSet.add("String Added")); }

The add Metode ini sangat penting sebagai rincian implementasi metode menggambarkan bagaimana TreeSet bekerja secara internal , bagaimana memanfaatkan TreeMap ini put metode untuk menyimpan elemen:

public boolean add(E e) { return m.put(e, PRESENT) == null; }

Variabel m mengacu pada dukungan internal TreeMap (perhatikan bahwa TreeMap mengimplementasikan NavigateableMap ):

private transient NavigableMap m;

Oleh karena itu, TreeSet secara internal bergantung pada dukungan NavigableMap yang diinisialisasi dengan sebuah instance dari TreeMap ketika sebuah instance dari TreeSet dibuat:

public TreeSet() { this(new TreeMap()); }

Lebih lanjut tentang ini dapat ditemukan di artikel ini.

4. TreeSet berisi ()

Metode contains () digunakan untuk memeriksa apakah elemen tertentu ada dalam TreeSet tertentu . Jika elemen ditemukan, itu mengembalikan true, jika tidak salah.

Mari kita lihat berisi () beraksi:

@Test public void whenCheckingForElement_shouldSearchForElement() { Set treeSetContains = new TreeSet(); treeSetContains.add("String Added"); assertTrue(treeSetContains.contains("String Added")); }

5. TreeSet hapus ()

Metode remove () digunakan untuk menghapus elemen yang ditentukan dari set jika ada.

Jika satu set berisi elemen yang ditentukan, metode ini mengembalikan nilai true.

Mari kita lihat aksinya:

@Test public void whenRemovingElement_shouldRemoveElement() { Set removeFromTreeSet = new TreeSet(); removeFromTreeSet.add("String Added"); assertTrue(removeFromTreeSet.remove("String Added")); }

6. TreeSet jelas ()

Jika kita ingin menghapus semua item dari satu set, kita bisa menggunakan metode clear () :

@Test public void whenClearingTreeSet_shouldClearTreeSet() { Set clearTreeSet = new TreeSet(); clearTreeSet.add("String Added"); clearTreeSet.clear(); assertTrue(clearTreeSet.isEmpty()); }

7. Ukuran TreeSet ()

Metode size () digunakan untuk mengidentifikasi jumlah elemen yang ada di TreeSet . Itu salah satu metode fundamental dalam API:

@Test public void whenCheckingTheSizeOfTreeSet_shouldReturnThesize() { Set treeSetSize = new TreeSet(); treeSetSize.add("String Added"); assertEquals(1, treeSetSize.size()); }

8. TreeSet isEmpty ()

Metode isEmpty () dapat digunakan untuk mengetahui apakah instance TreeSet yang diberikan kosong atau tidak:

@Test public void whenCheckingForEmptyTreeSet_shouldCheckForEmpty() { Set emptyTreeSet = new TreeSet(); assertTrue(emptyTreeSet.isEmpty()); }

9. Iterator TreeSet ()

The iterator() method returns an iterator iterating in the ascending order over the elements in the Set. Those iterators are fail-fast.

We can observe the ascending iteration order here:

@Test public void whenIteratingTreeSet_shouldIterateTreeSetInAscendingOrder() { Set treeSet = new TreeSet(); treeSet.add("First"); treeSet.add("Second"); treeSet.add("Third"); Iterator itr = treeSet.iterator(); while (itr.hasNext()) { System.out.println(itr.next()); } }

Additionally, TreeSet enables us to iterate through the Set in descending order.

Let's see that in action:

@Test public void whenIteratingTreeSet_shouldIterateTreeSetInDescendingOrder() { TreeSet treeSet = new TreeSet(); treeSet.add("First"); treeSet.add("Second"); treeSet.add("Third"); Iterator itr = treeSet.descendingIterator(); while (itr.hasNext()) { System.out.println(itr.next()); } }

The Iterator throws a ConcurrentModificationException if the set is modified at any time after the iterator is created in any way except through the iterator's remove() method.

Let's create a test for this:

@Test(expected = ConcurrentModificationException.class) public void whenModifyingTreeSetWhileIterating_shouldThrowException() { Set treeSet = new TreeSet(); treeSet.add("First"); treeSet.add("Second"); treeSet.add("Third"); Iterator itr = treeSet.iterator(); while (itr.hasNext()) { itr.next(); treeSet.remove("Second"); } } 

Alternatively, if we had used the iterator's remove method, then we wouldn't have encountered the exception:

@Test public void whenRemovingElementUsingIterator_shouldRemoveElement() { Set treeSet = new TreeSet(); treeSet.add("First"); treeSet.add("Second"); treeSet.add("Third"); Iterator itr = treeSet.iterator(); while (itr.hasNext()) { String element = itr.next(); if (element.equals("Second")) itr.remove(); } assertEquals(2, treeSet.size()); }

There's no guarantee on the fail-fast behavior of an iterator as it's impossible to make any hard guarantees in the presence of unsynchronized concurrent modification.

More about this can be found here.

10. TreeSet first()

This method returns the first element from a TreeSet if it's not empty. Otherwise, it throws a NoSuchElementException.

Let's see an example:

@Test public void whenCheckingFirstElement_shouldReturnFirstElement() { TreeSet treeSet = new TreeSet(); treeSet.add("First"); assertEquals("First", treeSet.first()); }

11. TreeSet last()

Analogously to the above example, this method will return the last element if the set is not empty:

@Test public void whenCheckingLastElement_shouldReturnLastElement() { TreeSet treeSet = new TreeSet(); treeSet.add("First"); treeSet.add("Last"); assertEquals("Last", treeSet.last()); }

12. TreeSet subSet()

This method will return the elements ranging from fromElement to toElement. Note that fromElement is inclusive and toElement is exclusive:

@Test public void whenUsingSubSet_shouldReturnSubSetElements() { SortedSet treeSet = new TreeSet(); treeSet.add(1); treeSet.add(2); treeSet.add(3); treeSet.add(4); treeSet.add(5); treeSet.add(6); Set expectedSet = new TreeSet(); expectedSet.add(2); expectedSet.add(3); expectedSet.add(4); expectedSet.add(5); Set subSet = treeSet.subSet(2, 6); assertEquals(expectedSet, subSet); }

13. TreeSet headSet()

This method will return elements of TreeSet which are smaller than the specified element:

@Test public void whenUsingHeadSet_shouldReturnHeadSetElements() { SortedSet treeSet = new TreeSet(); treeSet.add(1); treeSet.add(2); treeSet.add(3); treeSet.add(4); treeSet.add(5); treeSet.add(6); Set subSet = treeSet.headSet(6); assertEquals(subSet, treeSet.subSet(1, 6)); }

14. TreeSet tailSet()

This method will return the elements of a TreeSet which are greater than or equal to the specified element:

@Test public void whenUsingTailSet_shouldReturnTailSetElements() { NavigableSet treeSet = new TreeSet(); treeSet.add(1); treeSet.add(2); treeSet.add(3); treeSet.add(4); treeSet.add(5); treeSet.add(6); Set subSet = treeSet.tailSet(3); assertEquals(subSet, treeSet.subSet(3, true, 6, true)); }

15. Storing Null Elements

Before Java 7, it was possible to add null elements to an empty TreeSet.

However, that was considered a bug. Therefore, TreeSet no longer supports the addition of null.

When we add elements to the TreeSet, the elements get sorted according to their natural order or as specified by the comparator. Hence adding a null, when compared to existing elements, results in a NullPointerException since null cannot be compared to any value:

@Test(expected = NullPointerException.class) public void whenAddingNullToNonEmptyTreeSet_shouldThrowException() { Set treeSet = new TreeSet(); treeSet.add("First"); treeSet.add(null); }

Elements inserted into the TreeSet must either implement the Comparable interface or at least be accepted by the specified comparator. All such elements must be mutually comparable,i.e.e1.compareTo(e2) or comparator.compare(e1, e2)mustn't throw a ClassCastException.

Let's see an example:

class Element { private Integer id; // Other methods... } Comparator comparator = (ele1, ele2) -> { return ele1.getId().compareTo(ele2.getId()); }; @Test public void whenUsingComparator_shouldSortAndInsertElements() { Set treeSet = new TreeSet(comparator); Element ele1 = new Element(); ele1.setId(100); Element ele2 = new Element(); ele2.setId(200); treeSet.add(ele1); treeSet.add(ele2); System.out.println(treeSet); }

16. Performance of TreeSet

When compared to a HashSet the performance of a TreeSet is on the lower side. Operations like add, remove and search take O(log n) time while operations like printing n elements in sorted order require O(n) time.

A TreeSet should be our primary choice if we want to keep our entries sorted as a TreeSet may be accessed and traversed in either ascending or descending order, and the performance of ascending operations and views is likely to be faster than that of descending ones.

The Principle of Locality – is a term for the phenomenon in which the same values, or related storage locations, are frequently accessed, depending on the memory access pattern.

When we say locality:

  • Similar data is often accessed by an application with similar frequency
  • If two entries are nearby given an ordering, a TreeSet places them near each other in the data structure, and hence in memory

A TreeSet being a data-structure with greater locality we can, therefore, conclude in accordance to the Principle of Locality, that we should give preference to a TreeSet if we're short on memory and if we want to access elements that are relatively close to each other according to their natural ordering.

Jika data perlu dibaca dari hard drive (yang memiliki latensi lebih besar daripada data yang dibaca dari cache atau memori) maka pilih TreeSet karena memiliki lokalitas yang lebih besar

17. Kesimpulan

Pada artikel ini, kami fokus pada pemahaman bagaimana menggunakan implementasi TreeSet standar di Java. Kami melihat tujuannya dan seberapa efisiennya dalam hal kegunaan mengingat kemampuannya untuk menghindari duplikat dan menyortir elemen.

Seperti biasa, potongan kode dapat ditemukan di GitHub.