Merge pull request #11 from MineralsCloud:family

Rename `family` to `listfamily`

docs/src/public.md

@@ -9,6 +9,6 @@ Miller
 MillerBravais
 ReciprocalMiller
 ReciprocalMillerBravais
-family
+listfamily
 @m_str
 ```

src/miller.jl

@@ -2,7 +2,7 @@ using Combinatorics: permutations
 using StaticArrays: SVector
 
 export Miller, MillerBravais, ReciprocalMiller, ReciprocalMillerBravais
-export family, @m_str
+export listfamily, @m_str
 
 "Represent the Miller indices or Miller–Bravais indices."
 abstract type Indices <: AbstractVector{Int64} end
@@ -124,24 +124,25 @@ macro m_str(s)  # See https://github.com/JuliaLang/julia/blob/v1.9.3/base/regex.
 end
 
 """
-    family(x::Union{Miller,MillerBravais,ReciprocalMiller,ReciprocalMillerBravais})
+    listfamily(x::Union{Miller,MillerBravais,ReciprocalMiller,ReciprocalMillerBravais})
 
 List the all the directions/planes that are equivalent to `x` by symmetry.
 """
-function family(mb::T) where {T<:AbstractMillerBravais}
+function listfamily(mb::AbstractMillerBravais)
     perm = collect(permutations(mb[1:3]))  # Permute the first 3 indices for equivalent basis vectors
-    negate = -perm  # Use negative indices
+    negate = map(-, perm)  # Use negative indices
     pool = unique(append!(perm, negate))
-    allowed = filter(v -> v[3] == -v[1] - v[2], pool)
+    allowed = filter(_predicate, pool)
     return map(allowed) do x
-        T(x..., mb[4])  # Add the 4th index back
+        typeof(mb)(x..., mb[4])  # Add the 4th index back
     end
 end
-function family(m::T) where {T<:AbstractMiller}
-    mb = convert(T <: Miller ? MillerBravais : ReciprocalMillerBravais, m)  # Real or reciprocal space
-    vec = family(mb)
-    return map(x -> convert(T, x), vec)
+function listfamily(m::AbstractMiller)
+    mb = convert(typeof(m) <: Miller ? MillerBravais : ReciprocalMillerBravais, m)  # Real or reciprocal space
+    vec = listfamily(mb)
+    return map(Base.Fix1(convert, typeof(m)), vec)
 end
+_predicate(v) = v[3] == -v[1] - v[2]
 
 Base.parent(x::Indices) = x.data
 

test/miller.jl

@@ -93,14 +93,14 @@ end
 end
 @test convert(MillerBravais, Miller([1, 0, 0])) == MillerBravais([2, -1, -1, 0])
 
-@testset "Test `family`" begin
+@testset "Test `listfamily`" begin
     @testset "Test 1" begin
         m = Miller(-1, 0, 1)
-        @test Set(family(m)) == Set(
+        @test Set(listfamily(m)) == Set(
             Miller.([[1, 1, 1], [-1, 0, 1], [0, -1, 1], [-1, -1, 1], [1, 0, 1], [0, 1, 1]])
         )
         mb = MillerBravais(-1, -1, 2, 3)
-        @test Set(family(mb)) == Set(
+        @test Set(listfamily(mb)) == Set(
             MillerBravais.([
                 [1, 1, -2, 3],
                 [-2, 1, 1, 3],
@@ -113,13 +113,13 @@ end
     end
     @testset "Test 2" begin
         m = ReciprocalMiller(0, 1, 0)
-        @test Set(family(m)) == Set(
+        @test Set(listfamily(m)) == Set(
             ReciprocalMiller.([
                 [1, 0, 0], [0, 1, 0], [1, -1, 0], [-1, 0, 0], [0, -1, 0], [-1, 1, 0]
             ]),
         )
         mb = ReciprocalMillerBravais(0, -1, 1, 0)
-        @test Set(family(mb)) == Set(
+        @test Set(listfamily(mb)) == Set(
             ReciprocalMillerBravais.([
                 [1, 0, -1, 0],
                 [0, 1, -1, 0],
@@ -132,13 +132,13 @@ end
     end
     @testset "Test 3" begin
         m = ReciprocalMiller(1, 1, 0)
-        @test Set(family(m)) == Set(
+        @test Set(listfamily(m)) == Set(
             ReciprocalMiller.([
                 [1, 1, 0], [1, -2, 0], [-2, 1, 0], [-1, -1, 0], [-1, 2, 0], [2, -1, 0]
             ]),
         )
         mb = ReciprocalMillerBravais(-2, 1, 1, 0)
-        @test Set(family(mb)) == Set(
+        @test Set(listfamily(mb)) == Set(
             ReciprocalMillerBravais.([
                 [1, 1, -2, 0],
                 [1, -2, 1, 0],