Skip to content

Commit 302af10

Browse files
committed
Improvements to documentation, and creation of a tests directory for future development.
1 parent 5a5f868 commit 302af10

File tree

5 files changed

+21
-20
lines changed

5 files changed

+21
-20
lines changed

@annulusmap/annulusmap.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
function map = annulusmap(rgn)
22
%ANNULUSMAP Solve the nonlinear system for D-SC parameter.
3-
43
% ANNULUSMAP(RGN) solves the nonlinear system for D-SC parameter of a
5-
% doubly connected region RGN. RGN is an object of DSCPOLYGONS.
4+
% doubly connected region RGN as created by DSCPOLYGONS.
65
%
76
% See also DSCPOLYGONS.
8-
% Written by Alfa Heryudono, 2003.
7+
8+
% Copyright by Alfa Heryudono, 2003.
99

1010
% Get inner and outer polygons from region rgn
1111
[p1 p0] = get(rgn);

@annulusmap/display.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
function display(map)
2-
% Pretty-print D-SC parameters.
2+
%DISPLAY Pretty-print D-SC parameters.
3+
% Called automatically when a map is displayed at the command line.
34

4-
% Modification of POLYGON/DISPLAY.m
5-
% Modified by Alfa Heryudono, 2003.
5+
% Copyright by Alfa Heryudono, 2003.
66

77
fprintf('\n%s = DSC annulusmap:\n\n',inputname(1))
88
if imag(map.c) < 0

@annulusmap/dscinvmap.m

+9-10
Original file line numberDiff line numberDiff line change
@@ -1,15 +1,14 @@
1-
function w = dscinvmap(z,map)
2-
% DSCINVMAP Map a pt z to a pt w
1+
function w = dscinvmap(map,z)
2+
%DSCINVMAP Values of the inverse map.
3+
% DSCINVMAP(MAP,Z) finds the inverse image of a point Z under the annulusmap
4+
% MAP. That is, it maps from the DC polygonal domain MAP.REGION to the
5+
% annulus.
6+
%
7+
% See also ANNULUSMAP, ANNULUSMAP.DSCMAP.
38

4-
% DSCINVMAP(z,map) maps a pt z in the doubly connected region to the
5-
% annulus. map is an annulusmap object.
9+
% Copyright by Alfa Heryudono, 2003.
610

7-
% see @annulusmap/annulusmap.m
8-
9-
% check if z is in the doubly connected region
10-
% Not implemented yet.
11-
%----------------------
12-
%----------------------
11+
% TODO: check if z is in the doubly connected region
1312

1413
% z is not allowed to be a vertex.
1514
% check if z is in Z0.

@annulusmap/plot.m

+3-3
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,13 @@
11
function plot(map,varargin)
2-
%PLOT Create the graphical representation of the annulusmap.
3-
% PLOT(map) creates the graphical representation of the annulusmap.
2+
%PLOT Graphical representation of an annulusmap.
3+
% PLOT(MAP) creates a graphical representation of the annulusmap MAP.
44
%
55
% PLOT(map,'num') or PLOT(map,'lab') also plots dots for the vertices and
66
% numeric labels of inner polygon and outer polygon. For infinite vertices,
77
% two numeric labels are printed.
88

99
% Modification of dplot.
10-
% Modified by Alfa Heryudono, 2003.
10+
% Copyright by Alfa Heryudono, 2003.
1111

1212
% Plot the outer and inner polygon first.
1313
if nargin >1

test.m tests/dctests.m

+3-1
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
1+
% Tests of doubly-connected maps.
2+
13
clf;
2-
IPOLY = 1;
4+
IPOLY = 4;
35

46
% In the file dscsolv.m, between line 98 and 116
57
% nonlinear solver can use nesolve, sdogleg, or fsolve (optim toolbox).

0 commit comments

Comments
 (0)