%
% API Documentation for API Documentation
% Module coinor.blimpy.Stack'
%
% Generated by epydoc 3.0.1
% [Fri Mar 28 15:03:09 2014]
%

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                          Module Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}|(}
\section{Module coinor.blimpy.Stack'}

    \label{coinor:blimpy:Stack'}
A basic stack implementation using a linked list.

\textbf{Version:} 1.1.0



\textbf{Author:} Aykut Bulut, Ted Ralphs (ayb211@lehigh.edu,ted@lehigh.edu)



\textbf{License:} BSD




%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               Variables                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsection{Variables}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\raggedright \_\-\_\-e\-m\-a\-i\-l\-\_\-\_\- & \raggedright \textbf{Value:} 
{\tt \texttt{'}\texttt{ayb211@lehigh.edu}\texttt{'}}&\\
\cline{1-2}
\raggedright \_\-\_\-m\-a\-i\-n\-t\-a\-i\-n\-e\-r\-\_\-\_\- & \raggedright \textbf{Value:} 
{\tt \texttt{'}\texttt{Aykut Bulut}\texttt{'}}&\\
\cline{1-2}
\raggedright \_\-\_\-p\-a\-c\-k\-a\-g\-e\-\_\-\_\- & \raggedright \textbf{Value:} 
{\tt \texttt{'}\texttt{coinor.blimpy}\texttt{'}}&\\
\cline{1-2}
\raggedright \_\-\_\-t\-i\-t\-l\-e\-\_\-\_\- & \raggedright \textbf{Value:} 
{\tt \texttt{'}\texttt{Stack data structure}\texttt{'}}&\\
\cline{1-2}
\raggedright \_\-\_\-u\-r\-l\-\_\-\_\- & \raggedright \textbf{Value:} 
{\tt None}&\\
\cline{1-2}
\end{longtable}


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                           Class Description                           %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}|(}
\subsection{Class Stack}

    \label{coinor:blimpy:Stack':Stack}
\begin{tabular}{cccccc}
% Line for object, linespec=[False]
\multicolumn{2}{r}{\settowidth{\BCL}{object}\multirow{2}{\BCL}{object}}
&&
  \\\cline{3-3}
  &&\multicolumn{1}{c|}{}
&&
  \\
&&\multicolumn{2}{l}{\textbf{coinor.blimpy.Stack'.Stack}}
\end{tabular}

This stack class is built on top of a linked list data structure.


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                                Methods                                %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Methods}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_init\_\_}(\textit{self})

\setlength{\parskip}{2ex}
    x.\_\_init\_\_(...) initializes x; see help(type(x)) for signature

\setlength{\parskip}{1ex}
      Overrides: object.\_\_init\_\_ 	extit{(inherited documentation)}

    \end{boxedminipage}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_repr\_\_}(\textit{self})

\setlength{\parskip}{2ex}
    repr(x)

\setlength{\parskip}{1ex}
      Overrides: object.\_\_repr\_\_ 	extit{(inherited documentation)}

    \end{boxedminipage}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{\_\_str\_\_}(\textit{self})

\setlength{\parskip}{2ex}
    str(x)

\setlength{\parskip}{1ex}
      Overrides: object.\_\_str\_\_ 	extit{(inherited documentation)}

    \end{boxedminipage}

    \label{coinor:blimpy:Stack':Stack:isEmpty}
    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}!coinor.blimpy.Stack'.Stack.isEmpty \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{isEmpty}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{coinor:blimpy:Stack':Stack:peek}
    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}!coinor.blimpy.Stack'.Stack.peek \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{peek}(\textit{self}, \textit{item}={\tt None})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{coinor:blimpy:Stack':Stack:pop}
    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}!coinor.blimpy.Stack'.Stack.pop \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{pop}(\textit{self}, \textit{item}={\tt None})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{coinor:blimpy:Stack':Stack:push}
    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}!coinor.blimpy.Stack'.Stack.push \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{push}(\textit{self}, \textit{item})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{coinor:blimpy:Stack':Stack:remove}
    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}!coinor.blimpy.Stack'.Stack.remove \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{remove}(\textit{self}, \textit{item})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}

    \label{coinor:blimpy:Stack':Stack:size}
    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}!coinor.blimpy.Stack'.Stack.size \textit{(method)}}

    \vspace{0.5ex}

\hspace{.8\funcindent}\begin{boxedminipage}{\funcwidth}

    \raggedright \textbf{size}(\textit{self})

\setlength{\parskip}{2ex}
\setlength{\parskip}{1ex}
    \end{boxedminipage}


\large{\textbf{\textit{Inherited from object}}}

\begin{quote}
\_\_delattr\_\_(), \_\_format\_\_(), \_\_getattribute\_\_(), \_\_hash\_\_(), \_\_new\_\_(), \_\_reduce\_\_(), \_\_reduce\_ex\_\_(), \_\_setattr\_\_(), \_\_sizeof\_\_(), \_\_subclasshook\_\_()
\end{quote}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                              Properties                               %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Properties}

    \vspace{-1cm}
\hspace{\varindent}\begin{longtable}{|p{\varnamewidth}|p{\vardescrwidth}|l}
\cline{1-2}
\cline{1-2} \centering \textbf{Name} & \centering \textbf{Description}& \\
\cline{1-2}
\endhead\cline{1-2}\multicolumn{3}{r}{\small\textit{continued on next page}}\\\endfoot\cline{1-2}
\endlastfoot\multicolumn{2}{|l|}{\textit{Inherited from object}}\\
\multicolumn{2}{|p{\varwidth}|}{\raggedright \_\_class\_\_}\\
\cline{1-2}
\end{longtable}

    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}!coinor.blimpy.Stack'.Stack \textit{(class)}|)}
    \index{coinor \textit{(package)}!coinor.blimpy \textit{(package)}!coinor.blimpy.Stack' \textit{(module)}|)}
