teradataml 17.20.0.7__py3-none-any.whl → 20.0.0.1__py3-none-any.whl

teradataml/data/jsons/uaf/17.20/TD_IDFFT.json

@@ -1,58 +1,58 @@
-{
-        "FuncName": "TD_IDFFT",
-        "FuncDescriptionShort": "The reverse direction (Inverse) One Dimensional Discrete Fourier Transform",
-        "FuncDescriptionLong": [
-                "This function simply reverses the effects of the forward transform.  It takes as its input either a logical-runtime series containing complex number elements, or, alternatively, a logical-runtime series containing amplitude-phase pair elements; runs them through a reverse-transform summation formula; and outputs the original signal (time series or spatial series or arbitrary discrete series)  that was input into the TD_DFFT to generate the Fourier coefficients."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Temporal and Spatial",
-        "JSONVersion": "1",
-        "FuncRName": "td_IDFFT",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": ["SERIES", "ART"],
-                        "Description": [
-                                "It takes as its input a logical-runtime series, aka, 'a 1D array',  that has been populated previously with Fourier Transform coefficients.  The calculated coefficients may exist in either the form of : complex numbers - real and imaginary pairs; or exist as amplitude-phase pairs."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-                                "integer",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-                                "The output of the inverse transform is a logical result series - time series or spatial series or arbitrary series – containing a row-index and magnitudes.  The magnitudes will always be expressed as complex numbers.  The result will be indexed by a sequence of monotonically increasing integers beginning from 0.",
-                                "The TD_IDFFT function only generates a primary result set.  There are no secondary or tertiary result sets generated by this function.",
-                                "The TD_IDFFT transforms the input frequency domain series containing the Fourier coefficients back into a time/space domain series.    The elements of the result series are either CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX)."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-                {
-                        "Name": "HUMAN_READABLE",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 1,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "Required Parameter when input rows are in raw format.  Informs the TD_IDDFT as to whether the incoming DFFT coefficient rows are in a human-readable / plottable form; or if they are output in the raw-form, which is equivalent to how the 'R' and 'PYTHON' programs produce DFFT results.     A value of '1' means true, output in human readable form; a value of '0' means false, output in raw form.  Default is true - input rows are  in Human Readable format."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_IDFFT",
+        "FuncDescriptionShort": "The reverse direction (Inverse) One Dimensional Discrete Fourier Transform",
+        "FuncDescriptionLong": [
+                "This function simply reverses the effects of the forward transform.  It takes as its input either a logical-runtime series containing complex number elements, or, alternatively, a logical-runtime series containing amplitude-phase pair elements; runs them through a reverse-transform summation formula; and outputs the original signal (time series or spatial series or arbitrary discrete series)  that was input into the TD_DFFT to generate the Fourier coefficients."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_IDFFT",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": ["SERIES", "ART"],
+                        "Description": [
+                                "It takes as its input a logical-runtime series, aka, 'a 1D array',  that has been populated previously with Fourier Transform coefficients.  The calculated coefficients may exist in either the form of : complex numbers - real and imaginary pairs; or exist as amplitude-phase pairs."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The output of the inverse transform is a logical result series - time series or spatial series or arbitrary series – containing a row-index and magnitudes.  The magnitudes will always be expressed as complex numbers.  The result will be indexed by a sequence of monotonically increasing integers beginning from 0.",
+                                "The TD_IDFFT function only generates a primary result set.  There are no secondary or tertiary result sets generated by this function.",
+                                "The TD_IDFFT transforms the input frequency domain series containing the Fourier coefficients back into a time/space domain series.    The elements of the result series are either CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX)."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "HUMAN_READABLE",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 1,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Required Parameter when input rows are in raw format.  Informs the TD_IDDFT as to whether the incoming DFFT coefficient rows are in a human-readable / plottable form; or if they are output in the raw-form, which is equivalent to how the 'R' and 'PYTHON' programs produce DFFT results.     A value of '1' means true, output in human readable form; a value of '0' means false, output in raw form.  Default is true - input rows are  in Human Readable format."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }

teradataml/data/jsons/uaf/17.20/TD_IDFFT2.json

@@ -1,95 +1,95 @@
-{
-        "FuncName": "TD_IDFFT2",
-        "FuncDescriptionShort": "The reverse direction (Inverse) Two Dimensional Discrete Fourier Transform ",
-        "FuncDescriptionLong": [
-                "This function simply reverses the 2D Fourier Transform.  It takes as its input either a logical matrix containing Fourier coefficients in the form of complex number elements, or, alternatively, in the form of amplitude-phase pair (polar form) elements.   The function then runs them through a reverse-transform summation formula, and output the original logical matrix (original 2D array) that was input into the TD_DFFT2 to generate the Fourier coefficients. "
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "Temporal and Spatial",
-        "JSONVersion": "1",
-        "FuncRName": "td_IDFFT2",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": ["ART", "MATRIX"],
-                        "Description": [
-                                "It takes as its input a logical matrix that has been populated previously with 2D Fourier Transform coefficients.  The calculated coefficients may exist in either the form of : complex numbers - real and imaginary pairs; or exist as amplitude-phase pairs."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-                                "integer",
-                                "integer",
-                                "float",
-                                "float"
-                        ],
-                        "Description": [
-                                "The output of the inverse transform is a result matrix containing magnitudes.  The indexes for the rows and columns will be monotonically increasing integers beginning from 0.",
-                                "The TD_IDFFT2 function only returns a Primary Result set.  There are no Secondary or Tertiary Result sets returned by this function.  The Primary Result set can be returned by issuing a SELECT statement against the analytical result table containing the results.",
-                                "The TD_IDFFT2 transforms the input frequency domain matrix, containing the Fourier coefficients as elements, back into a matrix containing time/space domain entries.    The elements of the result matrix are either CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX).    "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-                {
-                        "Name": "HUMAN_READABLE",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 1,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "Required Parameter when input rows are in raw format.  Informs the TD_IDDFT as to whether the incoming DFFT coefficient rows are in a human-readable / plottable form; or if they are output in the raw-form, which is equivalent to how the 'R' and 'PYTHON' programs produce DFFT results.     A value of '1' means true, output in human readable form; a value of '0' means false, output in raw form.  Default is true – output in Human Readable format."
-                        ]
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": [
-                {
-                        "Name": "CONTENT",
-                        "Type": "string",
-                        "Optional": true,
-                        "PermittedValues": [
-                                "COMPLEX",
-                                "AMPL_PHASE_RADIANS",
-                                "AMPL_PHASE_DEGREES",
-                                "AMPL_PHASE",
-                                "MULTIVAR_COMPLEX",				 
-                                "MULTIVAR_AMPL_PHASE_RADIANS",
-                                "MULTIVAR_AMPL_PHASE_DEGREES",
-                                "MULTIVAR_AMPL_PHASE"
-                        ],
-                        "Description": [
-                                "The OUTPUT_FMT (CONTENT()) construct can be used by the data scientist to choose how they would like their Fourier coefficients to be output.  The can use CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX) to request the Fourier coefficients in rectangular form.  Alternatively, they can use CONTENT(AMPL_PHASE_RADIANS), CONTENT(AMPL_PHASE_DEGREES), CONTENT(AMPL_PHASE), CONTENT(MULTIVAR_AMPL_PHASE_RADIANS), CONTENT(MULTIVAR_AMPL_PHASE), or CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) to request that the Fourier coefficients be output in the polar form; and to further request the phase to be output in radians or degrees. ",
-                                "AMPL_PHASE is one of the permitted values, it is synonymous with AMPL_PHASE_RADIANS. Similarly MULTIVAR_AMPL_PHASE is equivalent to MULTIVAR_AMPL_PHASE_RADIANS.",
-                                "The default value is dependent on the datatype of the input series; a single var input will generate COMPLEX output CONTENT by default; a multi var input will generate MULTIVAR_COMPLEX output CONTENT by default."
-                        ],
-                        "LangName": "output_fmt_content"
-                },
-                {
-                        "Name": "ROW_MAJOR",
-                        "Type": "integer",
-                        "Optional": true,
-                        "DefaultValue": 1,
-                        "PermittedValues": [
-                                0,
-                                1
-                        ],
-                        "Description": [
-                                "The data scientist may explicity declare whether they want the matrix output in a row-major-centric or column-major-centric manner, via the OUTPUT_FMT(ROW_MAJOR()) construct."
-                        ],
-                        "LangName": "output_fmt_row_major"
-                }
-        ]
+{
+        "FuncName": "TD_IDFFT2",
+        "FuncDescriptionShort": "The reverse direction (Inverse) Two Dimensional Discrete Fourier Transform ",
+        "FuncDescriptionLong": [
+                "This function simply reverses the 2D Fourier Transform.  It takes as its input either a logical matrix containing Fourier coefficients in the form of complex number elements, or, alternatively, in the form of amplitude-phase pair (polar form) elements.   The function then runs them through a reverse-transform summation formula, and output the original logical matrix (original 2D array) that was input into the TD_DFFT2 to generate the Fourier coefficients. "
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "Temporal and Spatial",
+        "JSONVersion": "1",
+        "FuncRName": "td_IDFFT2",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": ["ART", "MATRIX"],
+                        "Description": [
+                                "It takes as its input a logical matrix that has been populated previously with 2D Fourier Transform coefficients.  The calculated coefficients may exist in either the form of : complex numbers - real and imaginary pairs; or exist as amplitude-phase pairs."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "integer",
+                                "integer",
+                                "float",
+                                "float"
+                        ],
+                        "Description": [
+                                "The output of the inverse transform is a result matrix containing magnitudes.  The indexes for the rows and columns will be monotonically increasing integers beginning from 0.",
+                                "The TD_IDFFT2 function only returns a Primary Result set.  There are no Secondary or Tertiary Result sets returned by this function.  The Primary Result set can be returned by issuing a SELECT statement against the analytical result table containing the results.",
+                                "The TD_IDFFT2 transforms the input frequency domain matrix, containing the Fourier coefficients as elements, back into a matrix containing time/space domain entries.    The elements of the result matrix are either CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX).    "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "HUMAN_READABLE",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 1,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "Required Parameter when input rows are in raw format.  Informs the TD_IDDFT as to whether the incoming DFFT coefficient rows are in a human-readable / plottable form; or if they are output in the raw-form, which is equivalent to how the 'R' and 'PYTHON' programs produce DFFT results.     A value of '1' means true, output in human readable form; a value of '0' means false, output in raw form.  Default is true – output in Human Readable format."
+                        ]
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": [
+                {
+                        "Name": "CONTENT",
+                        "Type": "string",
+                        "Optional": true,
+                        "PermittedValues": [
+                                "COMPLEX",
+                                "AMPL_PHASE_RADIANS",
+                                "AMPL_PHASE_DEGREES",
+                                "AMPL_PHASE",
+                                "MULTIVAR_COMPLEX",				 
+                                "MULTIVAR_AMPL_PHASE_RADIANS",
+                                "MULTIVAR_AMPL_PHASE_DEGREES",
+                                "MULTIVAR_AMPL_PHASE"
+                        ],
+                        "Description": [
+                                "The OUTPUT_FMT (CONTENT()) construct can be used by the data scientist to choose how they would like their Fourier coefficients to be output.  The can use CONTENT(COMPLEX) or CONTENT(MULTIVAR_COMPLEX) to request the Fourier coefficients in rectangular form.  Alternatively, they can use CONTENT(AMPL_PHASE_RADIANS), CONTENT(AMPL_PHASE_DEGREES), CONTENT(AMPL_PHASE), CONTENT(MULTIVAR_AMPL_PHASE_RADIANS), CONTENT(MULTIVAR_AMPL_PHASE), or CONTENT(MULTIVAR_AMPL_PHASE_DEGREES) to request that the Fourier coefficients be output in the polar form; and to further request the phase to be output in radians or degrees. ",
+                                "AMPL_PHASE is one of the permitted values, it is synonymous with AMPL_PHASE_RADIANS. Similarly MULTIVAR_AMPL_PHASE is equivalent to MULTIVAR_AMPL_PHASE_RADIANS.",
+                                "The default value is dependent on the datatype of the input series; a single var input will generate COMPLEX output CONTENT by default; a multi var input will generate MULTIVAR_COMPLEX output CONTENT by default."
+                        ],
+                        "LangName": "output_fmt_content"
+                },
+                {
+                        "Name": "ROW_MAJOR",
+                        "Type": "integer",
+                        "Optional": true,
+                        "DefaultValue": 1,
+                        "PermittedValues": [
+                                0,
+                                1
+                        ],
+                        "Description": [
+                                "The data scientist may explicity declare whether they want the matrix output in a row-major-centric or column-major-centric manner, via the OUTPUT_FMT(ROW_MAJOR()) construct."
+                        ],
+                        "LangName": "output_fmt_row_major"
+                }
+        ]
 }

teradataml/data/jsons/uaf/17.20/TD_INPUTVALIDATOR.json

@@ -1,64 +1,64 @@
-{
-        "FuncName": "TD_INPUTVALIDATOR",
-        "FuncDescriptionShort": "AF Utility function used to return in-discrete data",
-        "FuncDescriptionLong": [
-                "The TD_INPUTVALIDATOR, function is an AF Utility function used to return in-discrete data, which is passed to either SERIES_SPEC or MATRIX_SPEC through TABLE_NAME (input data). Few UAF functions required discrete data, so this function is used to find that in-discrete data. In-discrete data is classified differently for series and matrices."
-        ],
-        "FunctionVersion": "...",
-        "FunctionCategory": "General Utility",
-        "JSONVersion": "1",
-        "FuncRName": "td_Input_Validator",
-        "MaxInputFiles": 1,
-        "Input": [
-                {
-                        "Type": [
-                                "SERIES",
-                                "MATRIX"
-                        ],
-                        "Description": [
-                                "Series - Interval of ROW_AXIS field is stable (interval to be same); No duplicate row_axis in same series",
-                                "Matrix - Interval of ROW_AXIS field is stable; Interval of COLUMN_AXIS field is stable; No duplicate row_axis( column major) or no duplicate column_axis(row major) in same matrix; Number of rows in each walelet is same; or each wavelet, column_axis (row_axis) starts from same value under row major ( column major); Execute function returns the following columns to either user or ART is created with."
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
-                        "Optional": false
-                }
-        ],
-        "Output": [
-                {
-                        "Type": "ART",
-                        "PrimaryLayer": true,
-                        "LayerName": "ARTPRIMARY",
-                        "ResultTableColumnTypes": [
-                                "list<N, float>",
-                                "VARCHAR(256)"
-                        ],
-                        "Description": [
-                                "Invoking this AF utility function generates only a primary analytical result set. There are no secondary or other results generated. The primary result set can be accessed via a subsequent SELECT statement issued against the analytical result table. "
-                        ],
-                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
-                }
-        ],
-        "IsPlottable": true,
-        "Params": [
-                {
-                        "Name": "FAILURE_MODE",
-                        "Type": "string",
-                        "Optional": false,
-                        "PermittedValues": [
-                                "FUNC_FIRST",
-                                "FUNC_ALL"
-                        ],
-                        "Description": [
-                                "Either of the parameters are required",
-                                "FIRST - If row found to be in-discrete, then store this row and procede with next series / matrix. So only one row per series / marix.",
-                                "Use FUNC_FIRST to determine first in-discrete row, so that first and second rows are good. We have a valid interval. This helps, if first two rows are duplicates.",
-                                "ALL - If it is specified, all the rows that are in-discrete to be stored in series/ matrix. Then procede to next series / matrix and again follow the same as mentioned.",
-                                "Use FUNC_ALL, to see remaining rows are in-discrete. ",
-                                "There may be a scenario, as first and second row determines the interval. If interval is different from third row onwards and consistent throughout the series / matrix. Still you see all rows, except first and second rows. Here first and second rows are in-discrete. User can take action on first and second rows."
-                        ],
-                        "LangName": "..."
-                }
-        ],
-        "InputFmt": false,
-        "OutputFmt": false
+{
+        "FuncName": "TD_INPUTVALIDATOR",
+        "FuncDescriptionShort": "AF Utility function used to return in-discrete data",
+        "FuncDescriptionLong": [
+                "The TD_INPUTVALIDATOR, function is an AF Utility function used to return in-discrete data, which is passed to either SERIES_SPEC or MATRIX_SPEC through TABLE_NAME (input data). Few UAF functions required discrete data, so this function is used to find that in-discrete data. In-discrete data is classified differently for series and matrices."
+        ],
+        "FunctionVersion": "...",
+        "FunctionCategory": "General Utility",
+        "JSONVersion": "1",
+        "FuncRName": "td_Input_Validator",
+        "MaxInputFiles": 1,
+        "Input": [
+                {
+                        "Type": [
+                                "SERIES",
+                                "MATRIX"
+                        ],
+                        "Description": [
+                                "Series - Interval of ROW_AXIS field is stable (interval to be same); No duplicate row_axis in same series",
+                                "Matrix - Interval of ROW_AXIS field is stable; Interval of COLUMN_AXIS field is stable; No duplicate row_axis( column major) or no duplicate column_axis(row major) in same matrix; Number of rows in each walelet is same; or each wavelet, column_axis (row_axis) starts from same value under row major ( column major); Execute function returns the following columns to either user or ART is created with."
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field",
+                        "Optional": false
+                }
+        ],
+        "Output": [
+                {
+                        "Type": "ART",
+                        "PrimaryLayer": true,
+                        "LayerName": "ARTPRIMARY",
+                        "ResultTableColumnTypes": [
+                                "list<N, float>",
+                                "VARCHAR(256)"
+                        ],
+                        "Description": [
+                                "Invoking this AF utility function generates only a primary analytical result set. There are no secondary or other results generated. The primary result set can be accessed via a subsequent SELECT statement issued against the analytical result table. "
+                        ],
+                        "LangName": "data or object or newdata or ... --> Langauges team can work with UAF team to come up with this field"
+                }
+        ],
+        "IsPlottable": true,
+        "Params": [
+                {
+                        "Name": "FAILURE_MODE",
+                        "Type": "string",
+                        "Optional": false,
+                        "PermittedValues": [
+                                "FUNC_FIRST",
+                                "FUNC_ALL"
+                        ],
+                        "Description": [
+                                "Either of the parameters are required",
+                                "FIRST - If row found to be in-discrete, then store this row and procede with next series / matrix. So only one row per series / marix.",
+                                "Use FUNC_FIRST to determine first in-discrete row, so that first and second rows are good. We have a valid interval. This helps, if first two rows are duplicates.",
+                                "ALL - If it is specified, all the rows that are in-discrete to be stored in series/ matrix. Then procede to next series / matrix and again follow the same as mentioned.",
+                                "Use FUNC_ALL, to see remaining rows are in-discrete. ",
+                                "There may be a scenario, as first and second row determines the interval. If interval is different from third row onwards and consistent throughout the series / matrix. Still you see all rows, except first and second rows. Here first and second rows are in-discrete. User can take action on first and second rows."
+                        ],
+                        "LangName": "..."
+                }
+        ],
+        "InputFmt": false,
+        "OutputFmt": false
 }