%
% API Documentation for DareDare
% Module model.model
%
% Generated by epydoc 3.0.1
% [Sun Nov 23 16:35:56 2008]
%

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

    \index{model \textit{(package)}!model.model \textit{(module)}|(}
\section{Module model.model}

    \label{model:model}

%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                               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 C\- & \raggedright \textbf{Value:} 
{\tt {\textless}sympy.core.basic.ClassesRegistry instance at 0x96e56cc{\textgreater}}&\\
\cline{1-2}
\raggedright C\-a\-t\-a\-l\-a\-n\- & \raggedright \textbf{Value:} 
{\tt Catalan}&\\
\cline{1-2}
\raggedright E\- & \raggedright \textbf{Value:} 
{\tt E}&\\
\cline{1-2}
\raggedright E\-u\-l\-e\-r\-G\-a\-m\-m\-a\- & \raggedright \textbf{Value:} 
{\tt EulerGamma}&\\
\cline{1-2}
\raggedright G\-o\-l\-d\-e\-n\-R\-a\-t\-i\-o\- & \raggedright \textbf{Value:} 
{\tt GoldenRatio}&\\
\cline{1-2}
\raggedright I\- & \raggedright \textbf{Value:} 
{\tt I}&\\
\cline{1-2}
\raggedright S\- & \raggedright \textbf{Value:} 
{\tt S}&\\
\cline{1-2}
\raggedright n\-a\-n\- & \raggedright \textbf{Value:} 
{\tt nan}&\\
\cline{1-2}
\raggedright o\-o\- & \raggedright \textbf{Value:} 
{\tt oo}&\\
\cline{1-2}
\raggedright p\-i\- & \raggedright \textbf{Value:} 
{\tt pi}&\\
\cline{1-2}
\raggedright s\-i\-e\-v\-e\- & \raggedright \textbf{Value:} 
{\tt {\textless}Sieve with 6 primes sieved: 2, 3, 5, ... 11, 13{\textgreater}}&\\
\cline{1-2}
\raggedright z\-o\-o\- & \raggedright \textbf{Value:} 
{\tt zoo}&\\
\cline{1-2}
\end{longtable}


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

    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}|(}
\subsection{Class Model}

    \label{model:model:Model}

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

  \subsubsection{Methods}

    \label{model:model:Model:__init__}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.\_\_init\_\_ \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{\_\_init\_\_}(\textit{self}, \textit{fname}, \textit{lookup}={\tt False})

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

    \label{model:model:Model:check_all}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.check\_all \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{check\_all}(\textit{self}, \textit{print\_info}={\tt False}, \textit{print\_eq\_info}={\tt False})

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

    \label{model:model:Model:copy}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.copy \textit{(method)}}

    \vspace{0.5ex}

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

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

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

    \label{model:model:Model:current_equations}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.current\_equations \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{current\_equations}(\textit{self})

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

    \label{model:model:Model:future_variables}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.future\_variables \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{future\_variables}(\textit{self})

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

    \label{model:model:Model:get_jacobian}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.get\_jacobian \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{get\_jacobian}(\textit{self})

    \vspace{-1.5ex}

    \rule{\textwidth}{0.5\fboxrule}
\setlength{\parskip}{2ex}
    returns the jacobian of the equations with respect to 
    all\_variables\_f,all\_variables,all\_variables\_b where all\_variables
    == variables + exovariables

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

    \label{model:model:Model:is_matlab_compatible}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.is\_matlab\_compatible \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{is\_matlab\_compatible}(\textit{self})

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

    \label{model:model:Model:is_uhlig_compatible}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.is\_uhlig\_compatible \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{is\_uhlig\_compatible}(\textit{self})

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

    \label{model:model:Model:map_function_to_expression}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.map\_function\_to\_expression \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{map\_function\_to\_expression}(\textit{self}, \textit{f}, \textit{expr})

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

    \label{model:model:Model:process_portfolio_model}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.process\_portfolio\_model \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{process\_portfolio\_model}(\textit{self})

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

    \label{model:model:Model:set_info}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.set\_info \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{set\_info}(\textit{self}, \textit{eq})

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

    \label{model:model:Model:to_uhlig_model}
    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}!model.model.Model.to\_uhlig\_model \textit{(method)}}

    \vspace{0.5ex}

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

    \raggedright \textbf{to\_uhlig\_model}(\textit{self})

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


%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%
%%                            Class Variables                            %%
%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%%

  \subsubsection{Class 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 c\-o\-m\-m\-a\-n\-d\-s\- & \raggedright \textbf{Value:} 
{\tt None}&\\
\cline{1-2}
\raggedright c\-o\-v\-a\-r\-i\-a\-n\-c\-e\-s\- & \raggedright \textbf{Value:} 
{\tt \texttt{[}\texttt{]}}&\\
\cline{1-2}
\raggedright e\-q\-u\-a\-t\-i\-o\-n\-s\- & \raggedright \textbf{Value:} 
{\tt \texttt{[}\texttt{]}}&\\
\cline{1-2}
\raggedright e\-x\-o\-v\-a\-r\-i\-a\-b\-l\-e\-s\- & \raggedright \textbf{Value:} 
{\tt \texttt{[}\texttt{]}}&\\
\cline{1-2}
\raggedright f\-n\-a\-m\-e\- & \raggedright \textbf{Value:} 
{\tt None}&\\
\cline{1-2}
\raggedright i\-n\-i\-t\-\_\-v\-a\-l\-u\-e\-s\- & \raggedright \textbf{Value:} 
{\tt \texttt{\{}\texttt{\}}}&\\
\cline{1-2}
\raggedright p\-a\-r\-a\-m\-e\-t\-e\-r\-s\- & \raggedright \textbf{Value:} 
{\tt \texttt{[}\texttt{]}}&\\
\cline{1-2}
\raggedright s\-h\-o\-c\-k\-s\- & \raggedright \textbf{Value:} 
{\tt \texttt{[}\texttt{]}}&\\
\cline{1-2}
\raggedright v\-a\-r\-i\-a\-b\-l\-e\-s\- & \raggedright \textbf{Value:} 
{\tt \texttt{[}\texttt{]}}&\\
\cline{1-2}
\raggedright v\-a\-r\-i\-a\-b\-l\-e\-s\-\_\-o\-r\-d\-e\-r\- & \raggedright \textbf{Value:} 
{\tt \texttt{\{}\texttt{\}}}&\\
\cline{1-2}
\end{longtable}

    \index{model \textit{(package)}!model.model \textit{(module)}!model.model.Model \textit{(class)}|)}
    \index{model \textit{(package)}!model.model \textit{(module)}|)}
