Package it.univr.di.labeledvalue

Class LabeledIntTreeMap

java.lang.Object
it.univr.di.labeledvalue.AbstractLabeledIntMap
it.univr.di.labeledvalue.LabeledIntTreeMap
All Implemented Interfaces:
LabeledIntMap, Serializable
Direct Known Subclasses:
LabeledIntTreeMap.LabeledIntTreeMapView, LabeledIntTreeSimpleMap
public class LabeledIntTreeMap extends AbstractLabeledIntMap
Simple implementation of LabeledIntMap interface.

An experimental result on 2024-10-16 showed that using the base, there is a small improvement in the performance.

Execution time (ms) for some operations w.r.t the core data structure of the class (Object2IntMap).
Operation Using Object2IntOpenHashMap (ms) Using Object2IntArrayMap (ms)
Creating a map of 26 elements, adding 60 elements (some entries are simplified) 0.222982625 0.08684075
Finding the min value 0.002990083 0.003209583
Retrieve the value of label abd¿f 3.9083E-5 6.6917E-5
Simplification after insertion of (c,11) and (¬c,11) 0.056917 0.020042
All code for performance tests is in the ` LabeledIntTreeMapTest ` class (not publicly available).
Version:
$Rev: 993 $
Author:
Roberto Posenato
See Also:

  • Field Details

    • base

      char[] base
      A set of propositions forming a base for the labels of the map.

    • mainInt2SetMap

      it.unimi.dsi.fastutil.ints.Int2ObjectArrayMap<it.unimi.dsi.fastutil.objects.Object2IntMap<Label>> mainInt2SetMap
      Design choice: the set of labeled values of this map is organized as a collection of sets, each containing labels of the same length. This allows the label minimization task to be performed more systematically and efficiently. The efficiency has been proved by comparing this implementation with one in which the map has been realized with a standard map, and the minimization task determines the same length labels every time it needs them.

  • Constructor Details

    • LabeledIntTreeMap

      LabeledIntTreeMap(LabeledIntMap lvm, boolean optimize)
      Constructor to clone the structure. For optimization issues, this method clones only the LabeledIntTreeMap object.
      Parameters:
      lvm - the LabeledValueTreeMap to clone. If LVM is null, this will be an empty map.
      optimize - true for having the label as short as possible, false otherwise. For example, the set {(0, ¬C), (1, C)} is represented as {(0, ⊡), (1, C)} if this parameter is true.

    • LabeledIntTreeMap

      LabeledIntTreeMap(LabeledIntMap lvm)
      Constructor to clone the structure. For optimization issues, this method clones only the LabeledIntTreeMap object.
      Parameters:
      lvm - the LabeledValueTreeMap to clone. If LVM is null, this will be an empty map.

    • LabeledIntTreeMap

      LabeledIntTreeMap(boolean optimize)
      Necessary constructor for the factory. The internal structure is built and empty.
      Parameters:
      optimize - true for having the label as short as possible, false otherwise. For example, the set {(0, ¬C), (1, C)} is represented as {(0, ⊡), (1, C)} if this parameter is true.

    • LabeledIntTreeMap

      LabeledIntTreeMap()
      Necessary constructor for the factory. The internal structure is built and empty.

  • Method Details

    • alreadyRepresents

      public boolean alreadyRepresents(Label newLabel, int newValue)
      Parameters:
      newLabel - a Label object.
      newValue - the new value.
      Returns:
      true if the current map can represent the value. In a positive case, the addition of the element does not change the map. If it returns false, then adding the value to the map would modify the map.

    • clear

      public void clear()
      Description copied from interface: LabeledIntMap
      Remove all entries from the map.
      See Also:

    • entrySet

      public it.unimi.dsi.fastutil.objects.ObjectSet<it.unimi.dsi.fastutil.objects.Object2IntMap.Entry<Label>> entrySet()
      The set of all map entries. The set is a view of the map. A modification of the map is reflected in the entries of the returned set.
      If it is necessary to scan all the entries to modify the map, the only right way is to consider the keys returned by LabeledIntMap.keySet() and use methods like LabeledIntMap.remove(Label) and/or LabeledIntMap.put(Label, int).
      Up to 1000 items in the map, it is better to use this method instead of keySet() and get(Label) .
      With 1000 or more items, it is better to use keySet() approach.
      Returns:
      The set of all map entries.
      See Also:

    • get

      public int get(Label l)
      Parameters:
      l - an Label object.
      Returns:
      the value associated to l if it exists, Constants.INT_NULL otherwise.

    • getMaxValue

      public int getMaxValue()
      Returns:
      the maximum int value present in the set if the set is not empty; Constants.INT_NULL otherwise.

    • getMinValue

      public int getMinValue()
      Returns:
      the minimum int value present in the set if the set is not empty; Constants.INT_NULL otherwise.

    • getMinValueSubsumedBy

      public int getMinValueSubsumedBy(Label l)
      Description copied from interface: LabeledIntMap
      Returns the minimal value among those associated with labels subsumed by l if it exists, Constants.INT_NULL otherwise.
      Parameters:
      l - If it is null, Constants.INT_NULL is returned.
      Returns:
      minimal value among those associated with labels subsumed by l if it exists, Constants.INT_NULL otherwise.

    • keySet

      public it.unimi.dsi.fastutil.objects.ObjectSet<Label> keySet()
      Description copied from interface: LabeledIntMap
      A copy of all labels in the map.

      The returned set must not be connected to the map.

      The semantics of this method is different from the Map.keySet()!

      It can cost time and memory because it duplicates all the keys of the map.

      This method allows one to scan all the keys of the map, even if during the scan, some key of the map is removed.

      It is important to modify this map using only the method LabeledIntMap.remove(Label).

      Method LabeledIntMap.entrySet() returns a view of the entries of the map. Therefore, it cannot be used to scan or modify the map.

      Returns:
      a copy of all labels in the map.

    • newInstance

      public LabeledIntTreeMap newInstance()
      Description copied from interface: LabeledIntMap
      Factory
      Returns:
      an object of type LabeledIntMap.

    • newInstance

      public LabeledIntTreeMap newInstance(boolean optimize)
      Description copied from interface: LabeledIntMap
      Factory
      Parameters:
      optimize - true for having the label as short as possible, false otherwise. For example, the set {(0, ¬C), (1, C)} is represented as {(0, ⊡), (1, C)} if this parameter is true.
      Returns:
      an object of type LabeledIntMap.

    • newInstance

      public LabeledIntTreeMap newInstance(LabeledIntMap lim)
      Description copied from interface: LabeledIntMap
      Factory
      Parameters:
      lim - a map to clone.
      Returns:
      an object of type LabeledIntMap.

    • newInstance

      public LabeledIntTreeMap newInstance(LabeledIntMap lim, boolean optimize)
      Description copied from interface: LabeledIntMap
      Factory
      Parameters:
      lim - a map to clone.
      optimize - true for having the label as short as possible, false otherwise.
      For example, the set {(0, ¬C), (1, C)} is represented as {(0, ⊡), (1, C)} if this parameter is true.
      Returns:
      an object of type LabeledIntMap.

    • put

      public boolean put(Label newLabel, int newValue)
      Put a label with value i if label l is not null and there is no labeled value in the set with label l, or it is present but with a value higher than l.

      Not mandatory: the method can remove or modify other labeled values of the set to minimize the labeled values present, guaranteeing that no info is lost.

      IMPORTANT!
      This implementation tries to eliminate all redundant labels. Moreover, the code is sometimes redundant, but simple to check!

      Parameters:
      newLabel - a non-null label.
      newValue - a not Constants.INT_NULL value.
      Returns:
      true if (l,i) has been inserted. Since an insertion can remove more than one redundant labeled value, it is nonsensical to return "the old value" as expected from a classical put method.

    • putForcibly

      public void putForcibly(@Nonnull Label l, int i)
      Description copied from interface: LabeledIntMap
      Put the labeled value without any control. It is dangerous, but it can help in some cases.
      Parameters:
      l - a Label object.
      i - the new value. If it is Constants#INT_NULL, the method does nothing.

    • remove

      public int remove(@Nonnull Label l)
      Remove the label l from the map. If the l is not present, it does nothing.

      Warning!
      Use this method not during a map scan by entrySet()!

      Parameters:
      l - a non-null label.
      Returns:
      the previous value associated with l, or Constants.INT_NULL if there was no mapping for l.

    • unmodifiable

      public LabeledIntTreeMap.LabeledIntTreeMapView unmodifiable()
      Returns:
      a read-only view of this.

    • values

      public it.unimi.dsi.fastutil.ints.IntSet values()
      Returns:
      the set of all integer values present in the map as an ordered list.