📄 routines.html
字号:
<html>
<head>
<title>
Some useful routines
</title>
</head>
<body bgcolor=white>
<h1 align=center>Some useful routines from the library
<font color=red>ddtsa</font></h1>
This page shortly describes the routines which are included in the
library libddtsa.a. This library is created in the directory
dresd../../source_c/routines. The related header file is <a
href="../../source_c/routines/tsa.h" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/tsa.h">tsa.h</a>
<h3 align=center>Description of the routines</h3>
<ul>
<li><p><a href="../../source_c/routines/scan_help.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/scan_help.c">int scan_help</a>
<font color=red>(int argc,char **argv)</font>:
This routine just scans the options for a -h and returns a 1 if found
and a 0 if not.</p></li>
<li><p><a href="../../source_c/routines/get_series.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/get_series.c">double *get_series</a>
<font color=red>(char *name,
unsigned long *l,unsigned long ex, unsigned int col,
unsigned int verbosity)</font>:
This routine reads
a scalar time series from the file <font color=red>name</font> into
the array which is returned.<font color=red>l</font> is the number of
data read (will on return be the minimum of the file size and the value
given). The first <font color=red>ex</font> lines of the
file are ignored and the time series is supposed to be the <font
color=red>col</font>s column. <font color=red>verbosity</font>
specifies the <a href="../general.html#verbosity" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/docs/general.html#verbosity">verbosity level</a> of the program.
</p></li>
<li><p><a href="../../source_c/routines/search_datafile.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/search_datafile.c">
char* search_datafile</a><font color=red>(int n,char
**names,unsinged int *col)</font>
This routines gets an array of strings <font color=red>names</font>
of size <font color=red>n</font> and scans it for a name of an existing
file. It returns the filename in case it found one or a NULL pointer if
not. If the filename is given like <i>filename,i</i> the <i>i</i> is
interpreted as the column and is returned in <font
color=red>col</font>, if <font color=red>col</font> was not a pointer
to NULL.
</p></li>
<li><p><a href="../../source_c/routines/get_multi_series.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/get_multi_series.c">
double **get_multi_series</a><font color=red>(char *name,
unsigned long *l,unsigned long ex, unsigned int *col,
char *which,char colfix,unsigned int verbosity)</font>:
Reads a multivariate time series
and returns a
pointer to it. The first three parameters are the same as in
<font color=red>get_series</font>. <font color=red>*col</font> is the number
of columns to read and <font color=red>which</font> is a string which
contains the <a href="../general.html#columns" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/docs/general.html#columns">columns to be read</a>, separated by commas. <font
color=red>colfix</font> determines whether <font
color=red>*col</font> can be modified within the routine.<br>
Example: to read the first three columns:
<font color=red>which=1,2,3</font> or if the columns should be permuted
<font color=red>which=3,2,1</font> means: x=third column, ...<br>
If <font color=red>which</font> contains less columns than specified in
<font color=red>col</font> it is extended in such a way that columns are
appended that are larger than the largest given in
<font color=red>which</font>.<br>
Example: <font color=red>col=3</font>
<font color=red>which=1,2</font> -›<font color=red>which=1,2,3
</font> or <br>
<font color=red>which=5,1</font> -›<font color=red>which=5,1,6
</font><br>
If <font color=red>which</font> contains more columns than
specified in <font color=red>*col</font>, then <font
color=red>which</font> determines the number of columns to read
unless the dimension was specified on the command line, explicitely.
<font color=red>verbosity</font>
specifies the <a href="../general.html#verbosity" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/docs/general.html#verbosity">verbosity level</a> of the program.
</p></li>
<li><p><a href="../../../../../tppmsgs/msgs0.htm#46" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/source_check_option.c">char* check_option</a>
<font color=red>(char **str,int n,char flag,char type)</font>
This routine looks for the flag <font color=red>flag</font> in the
string array <font color=red>str</font> (typically argv) which has
<font color=red>n</font> (typically argc) entries. The flag is
supposed to be of type <font color=red>type</font>. See the sources
for the valid types. The return string contains the parameter for
the flag or NULL if none was found.
</p></li>
<li><p><a href="../../source_c/routines/rescale_data.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/rescale_data.c">void rescale_data</a>
<font color=red>
(double *s,unsigned long l,double *min,double *interval)</font>:
This routine rescales the data
in the array <font color=red>s</font>, which has a length
<font color=red>l</font>, to the interval [0:1]. On return
<font color=red>min</font> is the minimum of the original data and
<font color=red>interval</font> their original interval.</p></li>
<li><p><a href="../../source_c/routines/variance.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/variance.c">void variance</a>
<font color=red>(double *s,
unsigned long l,double *av,double *var)</font>. Simply calculates
the average <font color=red>av</font> and the variance
<font color=red>var</font> of a time series <font color=red>s</font>,
which has length <font color=red>l</font>.
</p></li>
<li><p><a href="../../source_c/routines/make_box.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/make_box.c">void make_box</a>
<font color=red>(double *s,long **box,long *list,
unsigned long l,unsigned int bs,unsigned int dim,unsigned int
del,double eps)</font>: This routine together with the
routine <a href="../../source_c/routines/find_neighbors.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/find_neighbors.c">find_neighbors</a>
constitute the <a href="../chaospaper/citation.html#box-assisted" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/docs/chaospaper/citation.html#box-assisted"> box-assisted
search algorithm</a>. The parameters are: The time series
<font color=red>s</font> of length
<font color=red>l</font>, a two dimensional <font
color=red>box</font> of dimension <font color=red>bs</font>, where
bs has to be a power of 2, the search <font color=red>list</font>,
also of length l, the dimension <font color=red>dim</font> of the
embedding vectors, which are build with delay <font
color=red>del</font> and the size <font color=red>eps</font> of
the boxes.</p></li>
<li><p><a href="../../source_c/routines/find_neighbors.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/find_neighbors.c">
unsigned long find_neighbors</a><font color=red>
(double *s,long **box,long *list,double *x,
unsigned long l,unsigned int bs,unsigned int dim,
unsigned int del,double eps,unsigned long *flist)</font>:
This routine searches for all neighbors of a vector
<font color=red>x</font> within the time series <font
color=red>s</font>. The indexes of the neighbors found are
stored in the array <font color=red>flist</font>, which has length
<font color=red>l</font> and the number of neighbors found is
returned. All other parameters have the same meaning as in the
routine
<a href="../../source_c/routines/make_box.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/make_box.c">make_box</a>.</p></li>
<li><p><a href="../../source_c/routines/solvele.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/solvele.c">
void solvele</a><font color=red>(double **mat,double *vec,unsigned
int dim)</font>: Solves a <font color=red>dim</font>-dimensional
system of linear equations given by <font
color=red><b>mat</b></font>*<b>x</b>=<font
color=red><b>vec</b></font>. It uses a Gaussian elimination
scheme. On return <font color=red>vec</font> contains <b>x</b>.
</p></li>
<li><p><a href="../../source_c/routines/invert_matrix.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/invert_matrix.c"> void invert_matrix</a>
<font color=red>(double **mat,unsigned int size)</font>: Inverts the
matrix <font color=red>mat</font> which is <font
color=red>size</font>x<font color=red>size</font>. It uses the
routine <a href="../../source_c/routines/solvele.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/solvele.c">solvele</a>.
</p></li>
<li><p><a href="../../source_c/routines/test_outfile.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/test_outfile.c">
void test_outfile</a><font color=red>(char *name)</font>:
This routine just checks whether the program can write to the file
named <font color=red>name</font>. If not the program exits.
</p></li>
<li><p><a href="../../source_c/routines/exclude_interval.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/exclude_interval.c">
unsigned long exclude_interval</a><font color=red>(unsigned long
found,long ex0,long ex1,long *before,long *newlist)</font>: This
routine is meant to be used in connection with the <a
href="../../source_c/routines/find_neighbors.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/find_neighbors.c">find_neighbors</a>
routine. After having found <font color=red>found</font> neighbors
which are stored in <font color=red>before</font> with the latter
routine, this new routine allows to exclude a interval of indexes
bounded by <font color=red>ex0</font> and <font color=red>ex1</font>
from this list. The modified list is returned in <font
color=red>newlist</font> and the new number of neigbors is the
return value of the routine.
</p></li>
<li><p><a href="../../source_c/routines/make_multi_box.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/make_multi_box.c">
void make_multi_box</a><font color=red>(double **series,long
**box,long *list,unsigned long length,unsigned int bs,unsigned int
dim, unsigned int emb, unsigned int del,double eps)</font>: This
routine is used to create the mesh for the box assisted search
algorithm in case you have multivariate data. The parameter <font
color=red>dim</font> determines the number of components of the
vector. All other parameter have the same meaning as in <a
href="../../source_c/routines/make_box.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/make_box.c">make_box</a>.
</p></li>
<li><p><a href="../../source_c/routines/find_multi_neighbors.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/find_multi_neighbors.c">
unsigned long find_multi_neighbors</a><font color=red>
(double *s,long **box,long *list,double **x,
unsigned long l,unsigned int bs,unsigned int dim,
unsigned int emb,unsigned int del,double eps,unsigned long
*flist)</font>:
This routine searches for all neighbors of a multicomponent vector
<font color=red>x</font> within the multicomponent time series <font
color=red>s</font>. <font color=red>dim</font> is the number of
components. All other parameters have the same meaning as the ones
of <a href="../../source_c/routines/find_neighbors.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/find_neighbors.c">
find_neighbors</a>.</p></li>
<li><p><a href="../../source_c/routines/what_i_do.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/what_i_do.c">void
what_i_do</a><font color=red>(char *text,char *name)</font>: Just
writes a message to stderr saying what the program <font
color=red>name</font> does (<font color=red>text</font>).
</p></li>
<li><p><a href="../../source_c/routines/myfgets.c" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/source_c/routines/myfgets.c">void
myfgets</a><font color=red>(char *str,int *size,FILE *fin, unsigned
int verbosity)</font>: This
routine wraps the fgets routine of C to handle looong input
lines. The parameters have the same meaning as in fgets. The only
differences are: <font color=red>size</font> can be changed inside
and <font color=red>verbosity</font> handles the <a href="../general.html#verbosity" tppabs="http://www.mpipks-dresden.mpg.de/~tisean/TISEAN_2.0/docs/general.html#verbosity">verbosity level</a> for
the output of warnings.
</p></li>
</ul>
</body>
</html>
⌨️ 快捷键说明
复制代码
Ctrl + C
搜索代码
Ctrl + F
全屏模式
F11
切换主题
Ctrl + Shift + D
显示快捷键
?
增大字号
Ctrl + =
减小字号
Ctrl + -