index :: data

global.bimap

Global visibility bidirectional map container

available since version: 0.9.7

---

information

NOTE: all object inlets are 'hot'

arguments:

• ID bimap ID
  type: symbol
  

methods:

• clear clear bidirectional map content
  

• insert insert new left-right map entry
  parameters:
  • PAIR list: LEFT_KEY RIGHT_KEY
    type: list
    required: True
    
• read read bimap from JSON file. Array of array pairs expected.
  parameters:
  • FNAME path to file, absolute or relative
    type: symbol
    required: True
    
• set set bidirectional map content
  parameters:
  • DATA new value list
    type: list
    required: True
    
• write write to JSON file, to overwrite existing file use @force flag
  parameters:

  • FNAME path to file, absolute or relative
    type: symbol
    required: True
    

  • [@force] force flag to overwrite existing files
    type: symbol
    

properties:

• @id (initonly) Get/set global variable id
  type: symbol
  default: default
  

• @value Get/set value, list of pairs: LEFT_KEY1 RIGHT_KEY1 LEFT_KEY2 RIGHT_KEY2 etc.
  type: list
  

• @size (readonly) Get number of left-right pairs in map
  type: int
  default: 0
  

• @empty (readonly) Get true if empty
  type: bool
  default: 1
  

• @keys_left (readonly) Get list of left map keys
  type: list
  

• @keys_right (readonly) Get list of right map keys
  type: list
  

inlets:

• try to find left key in the map and output the right value on success
  type: control
• try to find right key in the map and output the left value on success
  type: control

outlets:

• atom or list: right value output
  type: control
• atom or list: left value output
  type: control

keywords:

data global map container bidirectional

See also: [data.bimap] [local.bimap]

Authors: Serge Poltavsky

License: GPL3 or later