Skip to content

Clarify the api #33

@LecrisUT

Description

@LecrisUT

It is not so clear what the api for the dictionary and variable are. Ideally there should be a table matching the C++/Python interface to the fortran one. Basic API that should be documented:

  • Constructor
  • Adding a kv pair. If it already exists error/throw
  • Assigning a value to a key. If it doesn't exist error/throw
  • Add or assign
  • Get value
  • Delete key (deleting pointer or not)
  • Delete dictionary (deleting pointer or not)
  • Pop key
  • Itteration
  • Get size
  • Check if key exist

Those are dictionary, but for variable, that does not have a clear C++/Python counterpart, so I'm not sure what needs to be documented.

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions