# SPDX-License-Identifier: GPL-2.0-or-later
# ToolsForHomalg: Special methods and knowledge propagation tools
#
# Declarations
#

#! @Chapter Lazy arrays

#! @Section GAP categories

#! @Description
#!  The ⪆ category of lazy arrays.
#! @Arguments L
DeclareCategory( "IsLazyArray",
        IsComponentObjectRep and IsList );

#! @Section Constructors

#! @Description
#!  Construct a lazy array out of the nonnegative integer <A>n</A>
#!  and the function <A>func</A> defined in the range [ 0 .. <A>n</A> ],
#!  and possibly empty (sparse) list <A>values</A> of a posteriori possibly known values.
#! @Arguments n, func, values, type
#! @Group lazyarray
DeclareGlobalFunction( "LazyArrayWithValues" );

#! @Arguments n, func
#! @Group lazyarray
DeclareGlobalFunction( "LazyArray" );

#! @Arguments length
#! @Group lazyarray
DeclareGlobalFunction( "LazyStandardInterval" );

#! @Arguments length, start
#! @Group lazyarray
DeclareGlobalFunction( "LazyInterval" );

#! @Arguments n, number
#! @Group lazyarray
DeclareGlobalFunction( "LazyConstantArray" );

#! @Arguments list
#! @Group lazyarray
DeclareGlobalFunction( "LazyArrayFromList" );

#! @Section Operations

DeclareOperation( "ListOfValues", [ IsLazyArray ] );