Skip to main content
`Ctrl`+`K`

# Array API Standard Support: `cluster.hierarchy`

## Support on CPU

Legend

✔️ = supported

✖ = unsupported

N/A = out-of-scope

blank = not currently documented

function/class | torch | jax | dask
--- | --- | --- | ---
ClusterNode |  |  |
DisjointSet |  |  |
average | ✔️ | ✔️ | ✔️
centroid | ✔️ | ✔️ | ✔️
complete | ✔️ | ✔️ | ✔️
cophenet | ✔️ | ✔️ | ✔️
correspond | ✔️ | ✔️ | ✔️
cut_tree | ✖ | ✖ | ✖
dendrogram | ✔️ | ✔️ | ✔️
fcluster | ✔️ | ✔️ | ✔️
fclusterdata | ✔️ | ✔️ | ✔️
from_mlab_linkage | ✔️ | ✔️ | ✔️
inconsistent | ✔️ | ✔️ | ✔️
is_isomorphic | ✔️ | ✔️ | ✔️
is_monotonic | ✔️ | ✔️ | ✔️
is_valid_im | ✔️ | ✔️ | ✔️
is_valid_linkage | ✔️ | ✔️ | ✔️
leaders | ✔️ | ✔️ | ✔️
leaves_list | ✔️ | ✔️ | ✔️
linkage | ✔️ | ✔️ | ✔️
maxRstat | ✔️ | ✔️ | ✔️
maxdists | ✔️ | ✔️ | ✔️
maxinconsts | ✔️ | ✔️ | ✔️
median | ✔️ | ✔️ | ✔️
num_obs_linkage | ✔️ | ✔️ | ✔️
optimal_leaf_ordering | ✔️ | ✔️ | ✔️
set_link_color_palette | N/A | N/A | N/A
single | ✔️ | ✔️ | ✔️
to_mlab_linkage | ✔️ | ✔️ | ✔️
to_tree | ✔️ | ✔️ | ✔️
ward | ✔️ | ✔️ | ✔️
weighted | ✔️ | ✔️ | ✔️

## Support on GPU

Legend

✔️ = supported

✖ = unsupported

N/A = out-of-scope

blank = not currently documented

function/class | cupy | torch | jax
--- | --- | --- | ---
ClusterNode |  |  |
DisjointSet |  |  |
average | ✖ | ✖ | ✖
centroid | ✖ | ✖ | ✖
complete | ✖ | ✖ | ✖
cophenet | ✖ | ✖ | ✖
correspond | ✔️ | ✔️ | ✔️
cut_tree | ✖ | ✖ | ✖
dendrogram | ✖ | ✖ | ✖
fcluster | ✖ | ✖ | ✖
fclusterdata | ✖ | ✖ | ✖
from_mlab_linkage | ✖ | ✖ | ✖
inconsistent | ✖ | ✖ | ✖
is_isomorphic | ✔️ | ✔️ | ✔️
is_monotonic | ✔️ | ✔️ | ✔️
is_valid_im | ✔️ | ✔️ | ✔️
is_valid_linkage | ✔️ | ✔️ | ✔️
leaders | ✖ | ✖ | ✖
leaves_list | ✖ | ✖ | ✖
linkage | ✖ | ✖ | ✖
maxRstat | ✖ | ✖ | ✖
maxdists | ✖ | ✖ | ✖
maxinconsts | ✖ | ✖ | ✖
median | ✖ | ✖ | ✖
num_obs_linkage | ✔️ | ✔️ | ✔️
optimal_leaf_ordering | ✖ | ✖ | ✖
set_link_color_palette | N/A | N/A | N/A
single | ✖ | ✖ | ✖
to_mlab_linkage | ✔️ | ✔️ | ✔️
to_tree | ✔️ | ✔️ | ✔️
ward | ✖ | ✖ | ✖
weighted | ✖ | ✖ | ✖

## Support with JIT

Legend

✔️ = supported

✖ = unsupported

N/A = out-of-scope

blank = not currently documented

function/class | jax
--- | ---
ClusterNode |
DisjointSet |
average | ✔️
centroid | ✔️
complete | ✔️
cophenet | ✔️
correspond | ✔️
cut_tree | ✖
dendrogram | ✖
fcluster | ✖
fclusterdata | ✖
from_mlab_linkage | ✔️
inconsistent | ✔️
is_isomorphic | ✔️
is_monotonic | ✔️
is_valid_im | ✔️
is_valid_linkage | ✔️
leaders | ✖
leaves_list | ✔️
linkage | ✔️
maxRstat | ✔️
maxdists | ✔️
maxinconsts | ✔️
median | ✔️
num_obs_linkage | ✔️
optimal_leaf_ordering | ✔️
set_link_color_palette | N/A
single | ✔️
to_mlab_linkage | ✔️
to_tree | ✖
ward | ✔️
weighted | ✔️