diff --git a/docs/src/api/metrics.md b/docs/src/api/metrics.md index e7e8e94..1cf4139 100644 --- a/docs/src/api/metrics.md +++ b/docs/src/api/metrics.md @@ -39,7 +39,7 @@ CliffordNumbers.Metrics.STAP ```@docs CliffordNumbers.dimension -CliffordNumbers.basis_blades +CliffordNumbers.blade_count CliffordNumbers.grades CliffordNumbers.is_degenerate CliffordNumbers.is_positive_definite diff --git a/src/metrics.jl b/src/metrics.jl index 4e39e2e..d506df4 100644 --- a/src/metrics.jl +++ b/src/metrics.jl @@ -38,11 +38,12 @@ is equal to `2^dimension(s)`. dimension(s::AbstractSignature) = signed(s.dimensions) """ - blade_count(s::AbstractSignature) -> Int64 + blade_count(s) -> Int -Returns the total number of blades associated with `s`, which is equal to `2^dimension(s)`. +Returns the total number of blades associated with metric signature `s`, which is equal to +`2^dimension(s)`. """ -blade_count(s::AbstractSignature) = 2^dimension(s) +blade_count(s) = 2^dimension(s) """ grades(s::AbstractSignature) -> UnitRange{Int8}