Array Interface Test Suite #331

Activity

1. rafaqz commented on Jul 13, 2022

   

   rafaqz

   on Jul 13, 2022

   Last edited by rafaqz

   Contributor

   More actions

   I just registered this if you want to try it out. Structured interface tests with traits for free:

   https://github.com/rafaqz/Interfaces.jl

   Also let's you split an interface into components, e.g. making setindex! optional.

   Theres an implementation of IterationInterface in the BaseInterfaces.jl subpackage, which isn't registered yet. It might give more detail than the readme demo.
2. Tokazama commented on Jul 13, 2022

   

   Tokazama

   on Jul 13, 2022

   MemberAuthor

   More actions

   That's definitely interesting and there seems to be a consistent request for some way of guaranteeing that a new type provides valid support for an interface. Reading through the examples, it seems a lot more complex than just implementing a basic test suite composed of clearly documented functions. It would help if you could give an example of how this could be implemented for the multidimensional indices interface.
3. rafaqz commented on Jul 14, 2022

   

   rafaqz

   on Jul 14, 2022

   Last edited by rafaqz

   Contributor

   More actions

   @interface ArrayInterface (
       mandatory = (
           size = x -> length(x) == prod(size(x)),
           indices = (
               x -> length(eachindex(IndexLinear(), x)) == length(x),
               x -> length(CartesianIndices(axes(x))) == length(x),
               x -> map((l, c) -> x[l] == x[c], CartesianIndices(axes(x)), eachindex(IndexLinear(), x)) 
           ) 
       ),
       optional = (
           setindex! = x -> false # need to write these...,
           broadcast = x -> false,
       )
   )

   Then in a package

   julia> @implements ArrayInterface Array [zeros(10, 10)]
   
   true

   And we have traits:

   julia> Interfaces.implements(ArrayInterface, Array)
   true
   
   julia> Interfaces.implements(ArrayInterface{:setindex!}, Array)
   false

   Of course we just haven't written setindex! properly yet, but we also didn't specify that Array implements it.

   ❤️React with ❤️1Reacted by Zachary P Christensen
4. rafaqz commented on Jul 14, 2022

   

   rafaqz

   on Jul 14, 2022

   Last edited by rafaqz

   Contributor

   More actions

   Pretty much any of this can be changed if you have better ideas, the point was to get something started quickly - and returning NamedTuple of functions/functors for tests is very easy to write for when you need some of it to be modular.

   Edit: You can also organise that code however you like - the functions could be written separately. The macro doesn't do anything with the NamedTuple except use it as an object.

   E.g:

   function test_array_indices(x)
       lininds = eachindex(IndexLinear(), x)
       carinds = CartesianIndices(axes(x))
       for (li,ci) = zip(lininds,carinds)
           @test x[li] == x[ci]
       end
       return length(lininds) == length(carinds) == length(x) == prod(size(x))
   end
   
   @interface ArrayInterface (mandatory=(indices=test_array_indices,), optional=())

   I need to accept Test.Pass as true in Interfaces.jl then your code would work as-is. And maybe also allow skipping the mandatory/optional distinction when there are only mandatory components.
5. Tokazama commented on Jul 14, 2022

   

   Tokazama

   on Jul 14, 2022

   MemberAuthor

   More actions

   The examples are really helpful for understanding how to translate this. I'll make an issue with some more questions in the Interface.jl repo so this one can stay on topic for other comments about tests necessary for this to work.

   👍React with 👍1Reacted by Rafael Schouten