CVineStructure

class CVineStructure(*args, **kwargs)

A class for C-vine structures.

C-vines are a special class of R-vines where each tree is a star. A C-vine structure is determined entirely by the order of variables. For example, if the order is {1, 2, 3, 4}, the first tree in the vine connects variable 4 with all others, the second tree connects variable 3 with all others, etc.

Note that CVineStructure objects inherit the methods and attributes of RVineStructure objects.

Attributes

dim	Returns:
matrix	Gets the R-vine matrix representation.
order	Returns:
trunc_lvl	Returns:

Methods

__init__	Parameters:
from_dimension	Instantiates as a D-vine for a given dimension.
from_file	Instantiates an RVineStructure from a JSON or CBOR file.
from_json	Instantiates from a JSON-like str object.
from_matrix	Instantiates an RVineStructure object from a matrix representing an R-vine array.
from_order	Instantiates as a D-vine with a given ordering of the variables.
from_struct_array	Instantiates from the variable order (diagonal elements of the R-vine array) and a triangular structure array (elements above the diagonal).
from_trees	Assemble an RVineStructure from a list-of-trees decomposition.
get_struct_array	Extract structure array (all elements above the diagonal in the R-vine array).
get_trees	Gets the list-of-trees representation of the structure.
min_array	Access elements of the minimum array.
needed_hfunc1	Access elements of the needed_hfunc1 array.
needed_hfunc2	Access elements of the needed_hfunc2 array.
simulate	Randomly sample a regular vine structure.
struct_array	Accesses elements of the structure array.
to_file	Writes the structure into a JSON or CBOR file.
to_json	Converts the structure into a JSON-like str object.
truncate	Truncates the R-vine structure.