Function tskit::bindings::tsk_edge_table_init
source · pub unsafe extern "C" fn tsk_edge_table_init(
self_: *mut tsk_edge_table_t,
options: tsk_flags_t
) -> c_int
Expand description
@brief Initialises the table by allocating the internal memory.
@rst
This must be called before any operations are performed on the table.
See the :ref:sec_c_api_overview_structure
for details on how objects
are initialised and freed.
Options**
Options can be specified by providing one or more of the following bitwise flags:
- :c:macro:
TSK_TABLE_NO_METADATA
@endrst
@param self A pointer to an uninitialised tsk_edge_table_t object. @param options Allocation time options. @return Return 0 on success or a negative value on failure.