Quelle  _Chapter_Stacks.xml   Sprache: XML

<?xml version="1.0" encoding="UTF-8"?>

<!-- This is an automatically generated file. -->
<Chapter Label="Chapter_Stacks">
<Heading>Stacks</Heading>

<P/>
 A stack is a deque where items can be <C>Push</C>ed onto the stack, and
 the top item can be <C>Pop</C>ped off the stack.
<P/>
 Stacks are wrapped GAP plain lists.
<Section Label="Chapter_Stacks_Section_API">
<Heading>API</Heading>

<P/>
<ManSection>
  <Func Arg="" Name="Stack" />
 <Returns>stack
</Returns>
 <Description>
 Constructor for stacks
 </Description>
</ManSection>


<ManSection>
  <Filt Arg="arg" Name="IsStack" Label="for IsObject"/>
 <Returns><K>true</K> or <K>false</K>
</Returns>
 <Description>
 Category of heaps
 </Description>
</ManSection>


<ManSection>
  <Oper Arg="stack, object" Name="Push" Label="for IsStack, IsObject"/>
 <Description>
 Puts <A>object</A> onto <A>stack</A>.
<P/>
 </Description>
</ManSection>


<ManSection>
  <Oper Arg="stack" Name="Peek" Label="for IsStack"/>
 <Returns>object or <K>fail</K>
</Returns>
 <Description>
 Return the object at the top of <A>stack</A>. If <A>stack</A> is empty,
 returns <K>fail</K>
 </Description>
</ManSection>


<ManSection>
  <Oper Arg="stack" Name="Pop" Label="for IsStack"/>
 <Returns>object or <K>fail</K>
</Returns>
 <Description>
 Remove the top item from <A>stack</A> and return it.
 If <A>stack</A> is empty, this function returns fail.
 </Description>
</ManSection>


<ManSection>
  <Attr Arg="arg" Name="Size" Label="for [IsStack]"/>
 <Description>
 Number of elements on <A>stack</A>
 </Description>
</ManSection>


</Section>


</Chapter>