CharSet (HPPC vfalse API Documentation)

All Superinterfaces:: CharCollection, CharContainer, java.lang.Iterable<CharCursor>

All Known Implementing Classes:: CharHashSet

@Generated(date="2020-09-07T17:20:13+0200",
           value="KTypeSet.java")
public interface CharSet
extends CharCollection

A set of chars.

Method Summary

All Methods Instance Methods Abstract Methods
Modifier and Type	Method	Description
`boolean`	`add(char k)`	Adds `k` to the set.
`java.lang.String`	`visualizeKeyDistribution(int characters)`	Visually depict the distribution of keys.

Methods inherited from interface com.carrotsearch.hppc.CharCollection
clear, release, removeAll, removeAll, removeAll, retainAll, retainAll

Methods inherited from interface com.carrotsearch.hppc.CharContainer
contains, forEach, isEmpty, iterator, size, toArray

Methods inherited from interface java.lang.Iterable
forEach, spliterator

- Method Detail
  - add
```
boolean add(char k)
```
    Adds k to the set.
    
    Returns:
    
    Returns true if this element was not part of the set before. Returns false if an equal element is already part of the set, does not replace the existing element with the argument.
  - visualizeKeyDistribution
```
java.lang.String visualizeKeyDistribution(int characters)
```
    Visually depict the distribution of keys.
    
    Parameters:
    
    characters - The number of characters to "squeeze" the entire buffer into.
    
    Returns:
    
    Returns a sequence of characters where '.' depicts an empty fragment of the internal buffer and 'X' depicts full or nearly full capacity within the buffer's range and anything between 1 and 9 is between.