Recent changes to API basic

API basic modified by tanzheng

tanzheng — Thu, 14 Dec 2023 17:28:20 -0000

--- v2
+++ v3
@@ -1,3 +1,4 @@
+[Contents](https://github.com/xxyjskx1987/MathLabTool/wiki/API-Reference)
 * **mlt_page_console_log:** print log in MathLabTool's console.  
 ***ex:***

API basic modified by tanzheng

tanzheng — Thu, 14 Dec 2023 17:28:20 -0000

--- v1
+++ v2
@@ -3,20 +3,6 @@

     mlt_page_console_log('Hi Code!' + '\n');
     mlt_page_console_log('Hi Code!', '\n');
-* **csv2array:** Convert csv files to arrays.  
-***param:***  
-****path:**** Path and file name.  
-****data_begin_row:**** The data is collected from the first row.  
-****data_index_col:**** What column data to collect, array type.  
-****data_struct:**** 'col': the first dimension of the array is column data, 'raw': the first dimension of the array is row data.  
-***ex:***
-
-    var csv_ret = csv2array("D:/test.csv", {
-       data_begin_row: 1,
-       data_index_col: [6, 13, 20, 27, 34],
-       data_struct: 'col'
-    });
-    mlt_page_console_log(csv_ret, '\n');
 * **mlt_get_norm_dist_box_muller:** Generate normally distributed data (box-muller).  
 ***param:***  
 ****num:**** Number of samples.

API basic modified by tanzheng

tanzheng — Thu, 14 Dec 2023 17:28:19 -0000

mlt_page_console_log: print log in MathLabTool's console.
ex:

mlt_page_console_log('Hi Code!' + '\n');
mlt_page_console_log('Hi Code!', '\n');
* csv2array: Convert csv files to arrays.
param:
*path: Path and file name.
data_begin_row: The data is collected from the first row.
data_index_col: What column data to collect, array type.
data_struct: 'col': the first dimension of the array is column data, 'raw': the first dimension of the array is row data.
ex:*

var csv_ret = csv2array("D:/test.csv", {
data_begin_row: 1,
data_index_col: [6, 13, 20, 27, 34],
data_struct: 'col'
});
mlt_page_console_log(csv_ret, '\n');
* mlt_get_norm_dist_box_muller: Generate normally distributed data (box-muller).
param:
*num: Number of samples.
avg: Average value.
sr: Standard deviation.
ex:*

var nd = mlt_get_norm_dist_box_muller(500, 50, 20);
mlt_page_console_log(nd, '\n');
* mlt_get_average_sum_max_min: Generate average, quantity, maximum and minimum values.
param:
*data: Data to be computed, array type.
ex:*

var ret = mlt_get_average_sum_max_min([1, 2, 3, 4]);
mlt_page_console_log(ret, '\n');
* mlt_get_var_sr: Generate the variance and the standard deviation.
param:
*data: Data to be computed, array type.
avg: Average value of data.
ex:*

var var_sr = mlt_get_var_sr([1, 2, 3, 4], 2.5);
mlt_page_console_log(var_sr, '\n');
* mlt_kalman_filter: Kalman filtering.
param:
*data: Collect data, array type.
Q: Q。
R: R。
init_P: Initialize the P value.
init_predict_data: Initialize the predicted value.
ex:*

var kf = mlt_kalman_filter([1, 2, 5, 6], 0.05, 0.08, 0, 0);
mlt_page_console_log(kf, '\n');
* mlt_calc_formula: Calculate a custom formula.
param:
*formula: Custom formula.
i_var: Argument, array type.
i_var_val: Argument value, array type.
ex:*

var formula = "2 * x + (4 + x / 3 + (6 - 2 * 10 / 5) - 19) + 6 / x";
mlt_page_console_log(mlt_calc_formula(formula, ['x'], ['12']), '\n');