[PyX-checkins] pyx/manual path.tex,1.33,1.34 From: Jörg Lehmann - 2004-08-29 19:21:36 Update of /cvsroot/pyx/pyx/manual In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19342 Modified Files: path.tex Log Message: some updates to the path manual Index: path.tex =================================================================== RCS file: /cvsroot/pyx/pyx/manual/path.tex,v retrieving revision 1.33 retrieving revision 1.34 diff -C2 -d -r1.33 -r1.34 *** path.tex 1 Jun 2004 19:19:06 -0000 1.33 --- path.tex 29 Aug 2004 19:21:24 -0000 1.34 *************** *** 76,80 **** Returns a tuple consisting of two lists of parameter values corresponding to the intersection points of the path with the other ! path \var{opath}, respectively.$^\dagger$ \end{methoddesc} --- 76,81 ---- Returns a tuple consisting of two lists of parameter values corresponding to the intersection points of the path with the other ! path \var{opath}, respectively.$^\dagger$ For intersection points which ! are not farther apart then \var{epsilon} points, only one is returned. \end{methoddesc} *************** *** 85,88 **** --- 86,96 ---- \end{methoddesc} + \begin{methoddesc}{normpath}{epsilon=None} + Returns the equivalent \class{normpath}. For the conversion and for later + calculations with this \class{normpath} and accuracy of + \var{epsilon} points is used. If \var{epsilon} is \var{None}, the + global \var{epsilon} of the \module{path} module is used. + \end{methoddesc} + \begin{methoddesc}{range}{} Returns the maximal parameter value \var{param} that is allowed in the *************** *** 127,133 **** \item The $\dagger$ denotes methods which require a prior conversion of the path into a \class{normpath} instance. This is ! done automatically, but if you need to call such methods often or if you need to change the precision used for this conversion, ! it is a good idea to manually perform the conversion. \item Instead of using the \method{joined()} method, you can also join two paths together with help of the \verb|<<| operator, for instance --- 135,142 ---- \item The $\dagger$ denotes methods which require a prior conversion of the path into a \class{normpath} instance. This is ! done automatically (using the precision \var{epsilon} set globally ! using \method{path.set}), but if you need to call such methods often or if you need to change the precision used for this conversion, ! it is a good idea to perform the conversion manually. \item Instead of using the \method{joined()} method, you can also join two paths together with help of the \verb|<<| operator, for instance *************** *** 270,289 **** class above. ! Any path can easily be converted to its normalized form by passing it ! as parameter to the \class{normpath} constructor, \begin{verbatim} ! np = normpath(p) \end{verbatim} Additionally, you can specify the accuracy (in points) which is used ! in all \class{normpath} calculations by means of the keyword argument ! \var{epsilon}, which defaults to $10^{-5}$. Note that the sum of a ! \class{normpath} and a \class{path} always yields a \class{normpath}. ! \begin{classdesc}{normpath}{arg=[], epsilon=1e-5} ! Construct a normpath from \var{arg}. All numerical calculations will ! be performed using an accuracy of the order of \var{epsilon} points. ! The first argument \var{arg} can be a \class{path} or a another ! \class{normpath} instance. Alternatively, a list of ! \class{normsubpath} instances can be supplied as argument. \end{classdesc} --- 279,299 ---- class above. ! Any path can easily be converted to its normalized form by calling ! the \class{normpath} constructor, i.e., \begin{verbatim} ! np = p.normpath()) \end{verbatim} Additionally, you can specify the accuracy (in points) which is used ! in all \class{normpath} calculations by means of the argument ! \var{epsilon}, which defaults to the value defined using ! \function{path.set}. Initially, this value is set to $10^{-5}$ points. ! Note that the sum of a \class{normpath} and a \class{path} always ! yields a \class{normpath}. ! Alternatively, you can pass a list of \class{subnormpath} instances. ! ! \begin{classdesc}{normpath}{subnormpaths=[]} ! Construct a \class{normpath} consisting of \var{subnormpaths}, which ! is a list of \class{subnormpath} instances. \end{classdesc} *************** *** 305,308 **** --- 315,322 ---- \end{methoddesc} + \subsection{Class \class{subnormpath}} + + XXX To be written + \subsection{Predefined paths} 
 [PyX-checkins] pyx/manual path.tex,1.33,1.34 From: Jörg Lehmann - 2004-08-29 19:21:36 Update of /cvsroot/pyx/pyx/manual In directory sc8-pr-cvs1.sourceforge.net:/tmp/cvs-serv19342 Modified Files: path.tex Log Message: some updates to the path manual Index: path.tex =================================================================== RCS file: /cvsroot/pyx/pyx/manual/path.tex,v retrieving revision 1.33 retrieving revision 1.34 diff -C2 -d -r1.33 -r1.34 *** path.tex 1 Jun 2004 19:19:06 -0000 1.33 --- path.tex 29 Aug 2004 19:21:24 -0000 1.34 *************** *** 76,80 **** Returns a tuple consisting of two lists of parameter values corresponding to the intersection points of the path with the other ! path \var{opath}, respectively.$^\dagger$ \end{methoddesc} --- 76,81 ---- Returns a tuple consisting of two lists of parameter values corresponding to the intersection points of the path with the other ! path \var{opath}, respectively.$^\dagger$ For intersection points which ! are not farther apart then \var{epsilon} points, only one is returned. \end{methoddesc} *************** *** 85,88 **** --- 86,96 ---- \end{methoddesc} + \begin{methoddesc}{normpath}{epsilon=None} + Returns the equivalent \class{normpath}. For the conversion and for later + calculations with this \class{normpath} and accuracy of + \var{epsilon} points is used. If \var{epsilon} is \var{None}, the + global \var{epsilon} of the \module{path} module is used. + \end{methoddesc} + \begin{methoddesc}{range}{} Returns the maximal parameter value \var{param} that is allowed in the *************** *** 127,133 **** \item The $\dagger$ denotes methods which require a prior conversion of the path into a \class{normpath} instance. This is ! done automatically, but if you need to call such methods often or if you need to change the precision used for this conversion, ! it is a good idea to manually perform the conversion. \item Instead of using the \method{joined()} method, you can also join two paths together with help of the \verb|<<| operator, for instance --- 135,142 ---- \item The $\dagger$ denotes methods which require a prior conversion of the path into a \class{normpath} instance. This is ! done automatically (using the precision \var{epsilon} set globally ! using \method{path.set}), but if you need to call such methods often or if you need to change the precision used for this conversion, ! it is a good idea to perform the conversion manually. \item Instead of using the \method{joined()} method, you can also join two paths together with help of the \verb|<<| operator, for instance *************** *** 270,289 **** class above. ! Any path can easily be converted to its normalized form by passing it ! as parameter to the \class{normpath} constructor, \begin{verbatim} ! np = normpath(p) \end{verbatim} Additionally, you can specify the accuracy (in points) which is used ! in all \class{normpath} calculations by means of the keyword argument ! \var{epsilon}, which defaults to $10^{-5}$. Note that the sum of a ! \class{normpath} and a \class{path} always yields a \class{normpath}. ! \begin{classdesc}{normpath}{arg=[], epsilon=1e-5} ! Construct a normpath from \var{arg}. All numerical calculations will ! be performed using an accuracy of the order of \var{epsilon} points. ! The first argument \var{arg} can be a \class{path} or a another ! \class{normpath} instance. Alternatively, a list of ! \class{normsubpath} instances can be supplied as argument. \end{classdesc} --- 279,299 ---- class above. ! Any path can easily be converted to its normalized form by calling ! the \class{normpath} constructor, i.e., \begin{verbatim} ! np = p.normpath()) \end{verbatim} Additionally, you can specify the accuracy (in points) which is used ! in all \class{normpath} calculations by means of the argument ! \var{epsilon}, which defaults to the value defined using ! \function{path.set}. Initially, this value is set to $10^{-5}$ points. ! Note that the sum of a \class{normpath} and a \class{path} always ! yields a \class{normpath}. ! Alternatively, you can pass a list of \class{subnormpath} instances. ! ! \begin{classdesc}{normpath}{subnormpaths=[]} ! Construct a \class{normpath} consisting of \var{subnormpaths}, which ! is a list of \class{subnormpath} instances. \end{classdesc} *************** *** 305,308 **** --- 315,322 ---- \end{methoddesc} + \subsection{Class \class{subnormpath}} + + XXX To be written + \subsection{Predefined paths}