diversity

Low-level internals. This section documents the Rust-backed structures and functions that power cityseer. They are provided for reference. For analysis, use the higher-level wrappers instead: the CityNetwork class, or the metrics and tools modules. Symbols on these pages are not part of the public API and may change between releases without a deprecation cycle.

Functions for calculating diversity metrics in spatial analysis.

hill_diversity

hill_diversity
(
class_counts
q
)

hill_diversity_branch_distance_wt

hill_diversity_branch_distance_wt
(
class_counts
class_distances
q
beta
max_curve_wt
)

hill_diversity_pairwise_distance_wt

hill_diversity_pairwise_distance_wt
(
class_counts
class_distances
q
beta
max_curve_wt
)

gini_simpson_diversity

gini_simpson_diversity
(
class_counts
)

shannon_diversity

shannon_diversity
(
class_counts
)

raos_quadratic_diversity

raos_quadratic_diversity
(
class_counts
wt_matrix
alpha
beta
)