Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document IsNoImmediateMethodsObject officially, so that packages are free to use it (it already existed for a long time) #4529

Merged
merged 1 commit into from
Jun 2, 2021
Merged

Document IsNoImmediateMethodsObject officially, so that packages are free to use it (it already existed for a long time) #4529

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions doc/ref/methsel.xml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -323,6 +323,7 @@ For attributes and properties,
one can install also <E>immediate methods</E>.

<#Include Label="InstallImmediateMethod">
<#Include Label="IsNoImmediateMethodsObject">

</Section>

Expand Down
6 changes: 6 additions & 0 deletions lib/matobj2.gd
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -141,6 +141,12 @@
## However, row list matrices behave nearly like lists of row vectors
## that insist on being dense and containing only vectors of the same
## length and with the same base domain.
## <P/>
## Vector and matrix objects are not likely to benefit from &GAP;'s
## immediate methods (see section <Ref Sect="Immediate Methods"/>).
## Therefore it may be useful to set the filter
## <Ref Filt="IsNoImmediateMethodsObject"/> in the definition of new kinds
## of vector and matrix objects.
## <#/GAPDoc>
##

Expand Down
17 changes: 12 additions & 5 deletions lib/oper.g
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -210,16 +210,23 @@ fi;
##
#F IsNoImmediateMethodsObject(<obj>)
##
## <#GAPDoc Label="IsNoImmediateMethodsObject">
## <ManSection>
## <Func Name="IsNoImmediateMethodsObject" Arg='obj'/>
## <Filt Name="IsNoImmediateMethodsObject" Arg='obj'/>
##
## <Description>
## If this filter is set immediate methods will be ignored for <A>obj</A>. This
## can be crucial for performance for objects like PCGS, of which many are
## created, which are collections, but for which all those immediate
## methods for <C>IsTrivial</C> et cetera do not really make sense.
## If this filter is set immediate methods will be ignored for <A>obj</A>.
## This can be crucial for performance for objects like pcgs
## (see Section <Ref Sect="Polycyclic Generating Systems"/>), of which many
## are created, which are collections, but for which all those immediate
## methods for <Ref Prop="IsTrivial"/> et cetera do not really make sense.
## Other examples of objects in <Ref Filt="IsNoImmediateMethodsObject"/> are
## compressed vectors and matrices over small finite fields,
## see the sections <Ref Subsect="Row Vectors over Finite Fields"/> and
## <Ref Subsect="Matrices over Finite Fields"/>.
## </Description>
## </ManSection>
## <#/GAPDoc>
##
BIND_GLOBAL("IsNoImmediateMethodsObject",
NewFilter("IsNoImmediateMethodsObject"));
Expand Down