annotate +grid/evalOn.m @ 625:55e6267be117 feature/grids

Switch to using asserts for error checking
author Jonatan Werpers <jonatan@werpers.com>
date Fri, 20 Oct 2017 23:07:03 +0200
parents 0e20f4c9a94e
children da30d3bbeea6
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
rev   line source
276
30321dc180e1 Fixed documentation for Curvilinear and evalOn.
Jonatan Werpers <jonatan@werpers.com>
parents: 275
diff changeset
1 % Takes a function and evaluates it on a grid to return a grid function in the
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
2 % form of a (n*k)x1 vector, where n is the number of grid points and k is the
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
3 % number of components of the function.
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
4 % g -- Grid to evaluate on.
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
5 % func -- Function to evaluate. May be a function handle or a constant. If
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
6 % it is a vector value it has to be provided as a column vector,
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
7 function gf = evalOn(g, func)
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
8 if ~isa(func, 'function_handle')
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
9 % We should have a constant.
625
55e6267be117 Switch to using asserts for error checking
Jonatan Werpers <jonatan@werpers.com>
parents: 624
diff changeset
10 assert(size(func,2) == 1,'grid:evalOn:VectorValuedWrongDim', 'A vector valued function must be given as a column vector');
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
11
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
12 gf = repmat(func,[g.N, 1]);
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
13 return
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
14 end
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
15 % func should now be a function_handle
625
55e6267be117 Switch to using asserts for error checking
Jonatan Werpers <jonatan@werpers.com>
parents: 624
diff changeset
16 assert(g.D == nargin(func),'grid:evalOn:WrongNumberOfInputs', 'The number of inputs of the function must match the dimension of the domain.')
277
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
17
624
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
18 x = g.points();
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
19 k = numberOfComponents(func, x);
277
4c3f55a628c8 Made evalOn give more error message.
Jonatan Werpers <jonatan@werpers.com>
parents: 276
diff changeset
20
624
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
21 % Evaluate gf = func(x(:,1),x(:,2),...,x(:,dim));
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
22 if(g.D == 1)
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
23 gf = func(x);
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
24 else
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
25 eval_str = 'gf = func(x(:,1)';
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
26 for i = 2:g.D
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
27 eval_str = [eval_str, sprintf(',x(:,%d)',i)];
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
28 end
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
29 eval_str = [eval_str, ');'];
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
30 eval(eval_str);
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
31 end
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
32
624
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
33 % Reorganize gf
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
34 gf_temp = gf;
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
35 gf = zeros(g.N*k, 1);
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
36 for i = 1:k
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
37 gf(i:k:end) = gf_temp((i-1)*g.N + 1 : i*g.N);
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
38 end
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
39 end
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
40
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
41 % Find the number of vector components of func
0e20f4c9a94e Factor out function for calculating the number of components
Jonatan Werpers <jonatan@werpers.com>
parents: 623
diff changeset
42 function k = numberOfComponents(func, x)
582
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
43 if size(x,1) ~= 0
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
44 x0 = x(1,:);
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
45 else
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
46 x0 = num2cell(ones(1,size(x,2)));
ce44af8d7dd1 Rename grid.EmptyGrid to grid.Empty
Jonatan Werpers <jonatan@werpers.com>
parents: 277
diff changeset
47 end
622
0813d700a816 Remove whitespace
Jonatan Werpers <jonatan@werpers.com>
parents: 607
diff changeset
48
607
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
49 dim = length(x0);
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
50 % Evaluate f0 = func(x0(1),x0(2),...,x0(dim));
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
51 if(dim == 1)
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
52 f0 = func(x0);
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
53 else
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
54 eval_str = 'f0 = func(x0(1)';
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
55 for i = 2:dim
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
56 eval_str = [eval_str, sprintf(',x0(%d)',i)];
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
57 end
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
58 eval_str = [eval_str, ');'];
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
59 eval(eval_str);
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
60 end
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
61
0546de4b31a2 Make grid.evalOn faster.
Martin Almquist <malmquist@stanford.edu>
parents: 603
diff changeset
62 % k = number of components
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
63 k = length(f0);
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
64
625
55e6267be117 Switch to using asserts for error checking
Jonatan Werpers <jonatan@werpers.com>
parents: 624
diff changeset
65 assert(size(f0,2) == 1, 'grid:evalOn:VectorValuedWrongDim', 'A vector valued function must be given as a column vector');
157
ea8103ad2cc5 Added function eval on.
Jonatan Werpers <jonatan@werpers.com>
parents:
diff changeset
66 end