diversity

Low-level internals. These are the Rust-backed structures and functions that power cityseer. They carry no stability guarantee and are subject to breaking changes from time to time. Users are encouraged to use the higher-level wrappers instead, which are more stable: the CityNetwork class, or the metrics and tools modules. The basic information below is provided for those who do wish to work with the lower-level internals.

Functions for calculating diversity metrics in spatial analysis.

gini_simpson_diversity

gini_simpson_diversity
(
class_counts
)

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
)

raos_quadratic_diversity

raos_quadratic_diversity
(
class_counts
wt_matrix
alpha
beta
)

shannon_diversity

shannon_diversity
(
class_counts
)