annotate src/function.h @ 268:61830a4f9ab9

Improve formatting
author Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
date Thu, 14 Aug 2014 12:26:55 +0200
parents 5e9b5bbdc56b
children
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
1 /*
151
5fe2a157f4eb Update GPL to v3
gedeone-octave <marcovass89@hotmail.it>
parents: 80
diff changeset
2 Copyright (C) 2013 Marco Vassallo <gedeone-octave@users.sourceforge.net>
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
3
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
4 This program is free software; you can redistribute it and/or modify it under
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
5 the terms of the GNU General Public License as published by the Free Software
151
5fe2a157f4eb Update GPL to v3
gedeone-octave <marcovass89@hotmail.it>
parents: 80
diff changeset
6 Foundation; either version 3 of the License, or (at your option) any later
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
7 version.
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
8
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
9 This program is distributed in the hope that it will be useful, but WITHOUT
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
10 ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
11 FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
12 details.
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
13
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
14 You should have received a copy of the GNU General Public License along with
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
15 this program; if not, see <http://www.gnu.org/licenses/>.
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
16 */
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
17
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
18 #ifndef _FUNCTION_OCTAVE_
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
19 #define _FUNCTION_OCTAVE_
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
20
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
21 #include <memory>
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
22 #include <vector>
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
23 #include <dolfin.h>
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
24 #include <octave/oct.h>
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
25 #include <octave/parse.h>
253
5e9b5bbdc56b Support both DOLFIN 1.3.0 and 1.4.0
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 243
diff changeset
26 #include "dolfin_compat.h"
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
27
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
28 class function : public octave_base_value
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
29 {
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
30
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
31 public:
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
32
173
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
33 function ()
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
34 : octave_base_value (), fun () {}
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
35
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
36 function (std::string & _str,
253
5e9b5bbdc56b Support both DOLFIN 1.3.0 and 1.4.0
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 243
diff changeset
37 SHARED_PTR <const dolfin::Function> _fun)
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
38 : octave_base_value (), str (_str), fun (_fun) {}
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
39
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
40 function (function const & _func)
235
568aff85dfa9 Correct function constructor
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 234
diff changeset
41 : octave_base_value (), str (_func.get_str ()), fun (_func.get_pfun ()) {}
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
42
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
43 void
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
44 print (std::ostream & os,
173
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
45 bool pr_as_read_syntax = false) const
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
46 { os << "Function " << str << ": " << fun->str (true) << std::endl; }
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
47
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
48 ~function (void) {}
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
49
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
50 bool
173
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
51 is_defined (void) const
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
52 { return true; }
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
53
173
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
54 const dolfin::Function &
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
55 get_fun (void) const
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
56 { return (*fun); }
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
57
253
5e9b5bbdc56b Support both DOLFIN 1.3.0 and 1.4.0
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 243
diff changeset
58 const SHARED_PTR <const dolfin::Function> &
173
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
59 get_pfun (void) const
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
60 { return fun; }
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
61
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
62 void
173
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
63 set_fun (dolfin::Function & _fun)
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
64 {
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
65 dolfin::Function * p = new dolfin::Function (_fun);
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
66 fun = SHARED_PTR <const dolfin::Function> (p);
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
67 }
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
68
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
69 const std::string &
173
9e944b0d0fc8 Some Formatting improvements (?)
gedeone-octave <marcovass89@hotmail.it>
parents: 151
diff changeset
70 get_str (void) const
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
71 { return str; }
61
93e538063278 Add a string field to the class function
gedeone-octave <marco.vassallo@outlook.com>
parents: 46
diff changeset
72
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
73 octave_value
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
74 subsref (const std::string & type,
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
75 const std::list<octave_value_list> & idx)
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
76 {
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
77 octave_value retval;
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
78 retval = subsref (type, idx, 1);
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
79 return retval;
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
80 }
237
418a5119047b New interface for function evaluation
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 235
diff changeset
81
418a5119047b New interface for function evaluation
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 235
diff changeset
82 octave_value_list
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
83 subsref (const std::string & type,
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
84 const std::list<octave_value_list> & idx,
237
418a5119047b New interface for function evaluation
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 235
diff changeset
85 int nargout)
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
86 {
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
87 octave_value_list retval;
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
88
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
89 switch (type[0])
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
90 {
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
91 case '(':
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
92 {
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
93 retval = do_multi_index_op (nargout, idx.front ());
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
94 }
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
95 break;
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
96
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
97 case '{':
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
98 case '.':
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
99 {
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
100 std::string nm = type_name ();
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
101 error ("%s cannot be indexed with %c", nm.c_str (), type[0]);
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
102 }
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
103 break;
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
104
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
105 default:
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
106 { panic_impossible (); }
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
107 }
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
108
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
109 return retval;
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
110 }
234
94895618701f Add function evaluation with coordinates inside brackets
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 173
diff changeset
111
243
e51dba005f87 Add evaluation through anonymous functions
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 237
diff changeset
112 octave_value_list
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
113 do_multi_index_op (int nargout, const octave_value_list & idx)
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
114 {
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
115 octave_value_list retval;
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
116 std::list<octave_value_list> args (1, idx);
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
117 args.push_front (octave_value (new function (*this)));
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
118 retval = feval ("feval", args, nargout);
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
119 return retval;
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
120 }
243
e51dba005f87 Add evaluation through anonymous functions
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 237
diff changeset
121
268
61830a4f9ab9 Improve formatting
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 253
diff changeset
122 private:
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
123
61
93e538063278 Add a string field to the class function
gedeone-octave <marco.vassallo@outlook.com>
parents: 46
diff changeset
124 std::string str;
253
5e9b5bbdc56b Support both DOLFIN 1.3.0 and 1.4.0
Eugenio Gianniti <eugenio.gianniti@mail.polimi.it>
parents: 243
diff changeset
125 SHARED_PTR <const dolfin::Function> fun;
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
126
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
127 DECLARE_OCTAVE_ALLOCATOR;
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
128 DECLARE_OV_TYPEID_FUNCTIONS_AND_DATA;
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
129
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
130 };
80
16ccfaf1476a The function DEFINE_OCTAVE_ALLOCATOR and DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA
gedeone-octave <marcovass89@hotmail.it>
parents: 61
diff changeset
131 static bool function_type_loaded = false;
16ccfaf1476a The function DEFINE_OCTAVE_ALLOCATOR and DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA
gedeone-octave <marcovass89@hotmail.it>
parents: 61
diff changeset
132
16ccfaf1476a The function DEFINE_OCTAVE_ALLOCATOR and DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA
gedeone-octave <marcovass89@hotmail.it>
parents: 61
diff changeset
133 DEFINE_OCTAVE_ALLOCATOR (function);
16ccfaf1476a The function DEFINE_OCTAVE_ALLOCATOR and DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA
gedeone-octave <marcovass89@hotmail.it>
parents: 61
diff changeset
134 DEFINE_OV_TYPEID_FUNCTIONS_AND_DATA (function, "function", "function");
46
a64e195d0611 Wrapper class for dolfin::Function
gedeone-octave <marco.vassallo@outlook.com>
parents:
diff changeset
135 #endif