From 5b8caadfc4806a4160463e0de90cedd6e34eb9b2 Mon Sep 17 00:00:00 2001 From: detailer-asus Date: Thu, 29 Apr 2021 17:08:19 +0530 Subject: initialized doxygen doumentation --- doc/html/src_2fun_8h_source.html | 181 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 181 insertions(+) create mode 100644 doc/html/src_2fun_8h_source.html (limited to 'doc/html/src_2fun_8h_source.html') diff --git a/doc/html/src_2fun_8h_source.html b/doc/html/src_2fun_8h_source.html new file mode 100644 index 0000000..0cb657e --- /dev/null +++ b/doc/html/src_2fun_8h_source.html @@ -0,0 +1,181 @@ + + + + + + + +FOSSEE Scilab Octave Toolbox: src/fun.h Source File + + + + + + + + + + + + + + +
+
+ + + + + + + + +
+
FOSSEE Scilab Octave Toolbox +
+
This is a scilab toolbox to call octave functions. It requires octave to be installed on the system.
+
+ + + + + + +
+
+
+ + + +
+
+ +
+
+
+ +
+ +
+
+ + +
+ +
+ +
+
+
fun.h
+
+
+Go to the documentation of this file.
1 // Copyright (C) 2019 - IIT Bombay - FOSSEE
+
2 //
+
3 // This file must be used under the terms of the CeCILL.
+
4 // This source file is licensed as described in the file COPYING, which
+
5 // you should have received as part of this distribution. The terms
+
6 // are also available at
+
7 // http://www.cecill.info/licences/Licence_CeCILL_V2-en.txt
+
8 // Author: Rupak Rokade
+
9 // Organization: FOSSEE, IIT Bombay
+
10 // Email: toolbox@scilab.in
+
11 
+
12 #define fun_h__
+
13 //extern "C" int fun (double* answ, double* in1, int in1_row, std::string name, std::string opt);
+
14 
+
15 extern "C"
+
16 {
+
17 
+
18  typedef enum
+
19  {
+
20  TYPE_DOUBLE,
+
21  TYPE_STRING,
+
22  }FUNCTYPE;
+
23 
+
24  typedef struct
+
25  {
+
26  FUNCTYPE type;
+
27  int n_in_rows;
+
28  int n_in_cols;
+
29  int n_out_rows;
+
30  int n_out_cols;
+
31  int is_in_cmplx;
+
32  int is_out_cmplx;
+
33  void* in_data_real;
+
34  void* in_data_img;
+
35  void* out_data_real;
+
36  void* out_data_img;
+
37  }FUNCARGS;
+
38 
+
39  typedef struct {
+
40  int n_in_arguments; // number of input arguments
+
41  int n_out_arguments; // number of output arguments
+
42  int n_out_user; // number of output arguments
+
43  char *err; // Name
+
44  //char *package; //Name of octave package to be loaded
+
45  FUNCARGS *argument;
+
46 } FUNCCALL;
+
47 
+
48  int fun(FUNCARGS *arr, FUNCCALL *call);
+
49 }
+
FUNCTYPE
FUNCTYPE
Definition: fun.h:19
+
TYPE_DOUBLE
@ TYPE_DOUBLE
Definition: fun.h:20
+
TYPE_STRING
@ TYPE_STRING
Definition: fun.h:21
+
fun
int fun(FUNCARGS *arr, FUNCCALL *call)
Definition: fun.cpp:24
+
FUNCARGS
Definition: fun.h:25
+
FUNCARGS::out_data_img
void * out_data_img
Definition: fun.h:36
+
FUNCARGS::n_out_cols
int n_out_cols
Definition: fun.h:30
+
FUNCARGS::out_data_real
void * out_data_real
Definition: fun.h:35
+
FUNCARGS::is_out_cmplx
int is_out_cmplx
Definition: fun.h:32
+
FUNCARGS::n_in_rows
int n_in_rows
Definition: fun.h:27
+
FUNCARGS::n_in_cols
int n_in_cols
Definition: fun.h:28
+
FUNCARGS::type
FUNCTYPE type
Definition: fun.h:26
+
FUNCARGS::is_in_cmplx
int is_in_cmplx
Definition: fun.h:31
+
FUNCARGS::n_out_rows
int n_out_rows
Definition: fun.h:29
+
FUNCARGS::in_data_img
void * in_data_img
Definition: fun.h:34
+
FUNCARGS::in_data_real
void * in_data_real
Definition: fun.h:33
+
FUNCCALL
Definition: fun.h:39
+
FUNCCALL::n_in_arguments
int n_in_arguments
Definition: fun.h:40
+
FUNCCALL::n_out_arguments
int n_out_arguments
Definition: fun.h:41
+
FUNCCALL::argument
FUNCARGS * argument
Definition: fun.h:45
+
FUNCCALL::n_out_user
int n_out_user
Definition: fun.h:42
+
FUNCCALL::err
char * err
Definition: fun.h:43
+
+
+ + + + -- cgit