0.7.3

Nelson-numerical-software · Nelson-numerical-software · commit d378ff258d79 · 2023-03-27T21:03:02.000+02:00
diff --git a/en/README.md b/en/README.md
@@ -1,6 +1,6 @@
 ![banner](banner_homepage.png)
 
-### Nelson 0.7.2.0
+### Nelson 0.7.3.0
 
 This is an pre-release of Nelson.
 
diff --git a/en/SUMMARY.md b/en/SUMMARY.md
@@ -777,6 +777,7 @@
 
 - [graphics](./graphics/README.md)
 
+  - [ancestor](./graphics/ancestor.md)
   - [autumn](./graphics/autumn.md)
   - [axes](./graphics/axes.md)
   - [axis](./graphics/axis.md)
@@ -818,6 +819,7 @@
   - [meshz](./graphics/meshz.md)
   - [newplot](./graphics/newplot.md)
   - [parula](./graphics/parula.md)
+  - [patch](./graphics/patch.md)
   - [pcolor](./graphics/pcolor.md)
   - [pink](./graphics/pink.md)
   - [plot](./graphics/plot.md)
@@ -838,6 +840,7 @@
   - [text](./graphics/text.md)
   - [title](./graphics/title.md)
   - [turbo](./graphics/turbo.md)
+  - [validatecolor](./graphics/validatecolor.md)
   - [view](./graphics/view.md)
   - [viridis](./graphics/viridis.md)
   - [white](./graphics/white.md)
diff --git a/en/changelogs/CHANGELOG.md b/en/changelogs/CHANGELOG.md
@@ -4,6 +4,30 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## 0.7.3 (2023-03-28)
+
+### Added
+
+- `patch` Create patches of colored polygons.
+- `ancestor` Ancestor of graphics object.
+- hexadecimal color code managed example: '#DDFF00'.
+- `validatecolor` Validate color values.
+- [851](http://github.com/Nelson-numerical-software/nelson/issues/851): Build with micromamba environment (linux and macOS)
+
+### Changed
+
+- Figure property `Position` uses position based on bottom left position for compatibility.
+- internal: boost no more used to read/write json files.
+- internal: taglib library is optional.
+- version date updated with each build.
+
+### Fixed
+
+- [866](http://github.com/Nelson-numerical-software/nelson/issues/866): Close menu on figure can crash on linux.
+- graphic hierarchy was not fully destroyed after `close` or `delete`.
+- labels were not displayed correctly when the logarithmic scale was enabled.
+- [869](http://github.com/Nelson-numerical-software/nelson/issues/869): missing help files in linux package.
+
 ## 0.7.2 (2023-02-27)
 
 ### Changed
diff --git a/en/graphics/README.md b/en/graphics/README.md
@@ -6,6 +6,7 @@ Graphics functions
 
 graphics functions
 
+- [ancestor](ancestor.md) - Ancestor of graphics object.
 - [autumn](autumn.md) - Autumn colormap array.
 - [axes](axes.md) - Create cartesian axes.
 - [axis](axis.md) - Set axis limits and aspect ratios.
@@ -47,6 +48,7 @@ graphics functions
 - [meshz](meshz.md) - Mesh surface plot with curtain.
 - [newplot](newplot.md) - Prepare to produce a new plot.
 - [parula](parula.md) - Parula colormap array.
+- [patch](patch.md) - Create patches of colored polygons
 - [pcolor](pcolor.md) - Pseudocolor plot.
 - [pink](pink.md) - Pink colormap array.
 - [plot](plot.md) - Linear 2-D plot.
@@ -67,6 +69,7 @@ graphics functions
 - [text](text.md) - creates text descriptions to data points.
 - [title](title.md) - Add title.
 - [turbo](turbo.md) - Turbo colormap array.
+- [validatecolor](validatecolor.md) - Validate color values.
 - [view](view.md) - Camera line of sigh.
 - [viridis](viridis.md) - Viridis colormap array.
 - [white](white.md) - white colormap array.
diff --git a/en/graphics/SUMMARY.md b/en/graphics/SUMMARY.md
@@ -1,4 +1,5 @@
 - [graphics](README.md)
+  - [ancestor](ancestor.md)
   - [autumn](autumn.md)
   - [axes](axes.md)
   - [axis](axis.md)
@@ -40,6 +41,7 @@
   - [meshz](meshz.md)
   - [newplot](newplot.md)
   - [parula](parula.md)
+  - [patch](patch.md)
   - [pcolor](pcolor.md)
   - [pink](pink.md)
   - [plot](plot.md)
@@ -60,6 +62,7 @@
   - [text](text.md)
   - [title](title.md)
   - [turbo](turbo.md)
+  - [validatecolor](validatecolor.md)
   - [view](view.md)
   - [viridis](viridis.md)
   - [white](white.md)
diff --git a/en/graphics/ancestor.md b/en/graphics/ancestor.md
@@ -0,0 +1,47 @@
+# ancestor
+
+Ancestor of graphics object.
+
+## Syntax
+
+- p = ancestor(h, type)
+- p = ancestor(h, type, 'toplevel')
+
+## Input argument
+
+- h - graphics object
+- type - a row vector character or cell of strings:
+- 'toplevel' - a row vector character: return the highest parent in the object hierarchy that matches the condition.
+
+## Output argument
+
+- p - a graphics object or []
+
+## Description
+
+  <p><b>ancestor</b> returns the handle of the specified object's ancestor of a given type.</p>
+
+## Example
+
+```matlab
+f = figure();
+ax = gca();
+s = surf(peaks);
+AX = ancestor(s, 'axes')
+F = ancestor(s, 'figure')
+R = ancestor(s, 'root')
+```
+
+## See also
+
+[gcf](gcf.md).
+
+## History
+
+| Version | Description     |
+| ------- | --------------- |
+| 1.0.0   | initial version |
+
+## Author
+
+Allan CORNET
diff --git a/en/graphics/axes.md b/en/graphics/axes.md
@@ -43,7 +43,7 @@ Create cartesian axes.
   <p><b>CameraViewAngleMode</b> Selection mode for CameraViewAngle: 'manual' or 'auto' (default).</p>
   <p><b>Children</b> Array of graphics objects:  A vector containing graphics objects to children of the current axis.</p>
   <p><b>Clipping</b> Clipping of objects to axes limits: 'on' (default) or 'off'.</p>
-  <p><b>Color</b> Background color for the axes: RGB triplet or string color.</p>
+  <p><b>Color</b> Background color for the axes: RGB triplet, string color or hexadecimal color code.</p>
   <p><b>ColorOrder</b> Color order: three-column matrix of RGB triplets.</p>
   <p><b>ColorOrderIndex</b>Color order index: positive integer value, specifies the next color used.</p>
   <p><b>DataAspectRatio</b> Relative length of data units: vector [x, y, z].</p>
diff --git a/en/graphics/figure.md b/en/graphics/figure.md
@@ -30,15 +30,16 @@ Creates an figure window.
   <p/>
   <p><b>AlphaMap</b>: Transparency map for Axes content.</p>
   <p><b>Children</b>: Children of figure: empty array (default) or 1-D array of objects.</p>
-  <p><b>Color</b>: Background color [R, G, B] or string (example: 'blue').</p>
+  <p><b>Color</b>: Background color [R, G, B] or string (example: 'blue') or hexadecimal color code ('#FFAA00').</p>
   <p><b>Colormap</b>: Color map for axes content of figure: m-by-3 array of RGB triplets, parula (default).</p>
   <p><b>CurrentAxes</b>: Target axes in current figure: Axes object.</p>
   <p><b>Name</b>: Name (default '').</p>
   <p><b>NextPlot</b>: Directive on how to add next plot: 'new', 'replace', 'replacechildren' or 'add' (default).</p>
   <p><b>Number</b>: Figure Number.</p>
   <p><b>NumberTitle</b>: Use number title: 'off' or 'on' (default).</p>
   <p><b>Parent</b>: Figure parent: root graphics object.</p>
-  <p><b>Position</b>: Location and size of drawable area.</p>
+  <p><b>Position</b>: Location and size of drawable area: [left, bottom, width, height]</p>
+  <p>'width' and 'height' define the size of the window. 'left' and 'bottom' define the position of the first addressable pixel in the lower left corner of the window</p>
   <p><b>Tag</b>: Object identifier: string scalar, character vector, '' (default).</p>
   <p><b>Type</b>: Type 'figure'.</p>
   <p><b>UserData</b>: User data: array or [] (default).</p>
diff --git a/en/graphics/image.md b/en/graphics/image.md
@@ -67,7 +67,7 @@ image();
 
 ## See also
 
-[imagesc](imagesc.md), [colormap](colormap.html).
+[imagesc](imagesc.md), [colormap](colormap.md).
 
 ## History
 
diff --git a/en/graphics/imagesc.md b/en/graphics/imagesc.md
@@ -68,7 +68,7 @@ colormap(gray)
 
 ## See also
 
-[image](image.md), [colormap](colormap.html).
+[image](image.md), [colormap](colormap.md).
 
 ## History
 
diff --git a/en/graphics/imshow.md b/en/graphics/imshow.md
@@ -42,7 +42,7 @@ h = imshow(filename)
 
 ## See also
 
-[imread](imread.md), [image](image.md), [imagesc](imagesc.md), [colormap](colormap.html).
+[imread](imread.md), [image](image.md), [imagesc](imagesc.md), [colormap](colormap.md).
 
 ## History
 
diff --git a/en/graphics/line.md b/en/graphics/line.md
@@ -28,7 +28,7 @@ Create primitive line.
   <p>Properties:</p>
   <p/>
   <p><b>Children</b> [] (currently not used).</p>
-  <p><b>Color</b> Line color: RGB triplet, [0, 0, 0] </p>
+  <p><b>Color</b> Line color: RGB triplet, [0, 0, 0] or hexadecimal color code.</p>
   <p><b>DisplayName</b> Legend label: character vector or string scalar, '' (default).</p>
   <p><b>LineStyle</b> Line style: '--', ':', '-.', 'none' or '-' (default).</p>
   <p><b>LineWidth</b> Line width: scalar positive value.</p>
diff --git a/en/graphics/patch.md b/en/graphics/patch.md
@@ -0,0 +1,101 @@
+# patch
+
+Create patches of colored polygons
+
+## Syntax
+
+- patch(X, Y, C)
+- patch(X, Y, Z, C)
+- patch('XData', X, 'YData', Y)
+- patch('XData', X, 'YData', Y, 'ZData', Z)
+- patch('Faces', F, 'Vertices', V)
+- patch(S)
+- patch(..., propertyName, propertyValue)
+- patch(ax, ...)
+- go = patch(...)
+
+## Input argument
+
+- X - x-coordinates: vector or matrix.
+- Y - y-coordinates: vector or matrix.
+- Z - z-coordinates: vector or matrix.
+- C - Color array: scalar, vector, m-by-n-by-3 array of RGB triplets.
+- ax - a scalar graphics object value: parent container, specified as a axes.
+- propertyName - a scalar string or row vector character.
+- propertyValue - a value.
+- S - a structure with fields that correspond patch property names and field values.
+
+## Output argument
+
+- go - a graphics object: patch type.
+
+## Description
+
+  <p><b>patch(X, Y, C)</b> creates a 2D polygonal shape with vertices defined by <b>X</b> and <b>Y</b> coordinates, and fills the shape with color <b>C</b>.</p>
+  <p><b>patch(X, Y, Z, C)</b> creates a 3D polygonal shape with vertices defined by <b>X</b>, <b>Y</b>, and <b>Z</b> coordinates, and fills the shape with color <b>C</b>.</p>
+  <p><b>patch(..., PropertyName, PropertyValue, ...)</b> sets optional properties for the patch object using name-value pairs.</p>
+  <p><b>patch('Faces', F, 'Vertices', V)</b> creates one or more polygons .</p>
+  <p><b>go = patch(...)</b> returns the handle <b>go</b> to the created patch object.</p>
+  <p>Property Name-Value Pairs:</p>
+  <p/>
+  <p><b>'FaceColor'</b>: color of the filled shape. FaceColor can be a character vector or a 3-element RGB vector. Default: <b>'flat'</b>.</p>
+  <p><b>'EdgeColor'</b>: color of the edges of the polygonal shape. EdgeColor can be a character vector or a 3-element RGB vector. Default: <b>'none'</b>.</p>
+  <p><b>'LineWidth'</b>: width of the edges of the polygonal shape. Default: <b>0.5</b>.</p>
+  <p><b>'LineStyle'</b>: style of the edges of the polygonal shape. LineStyle can be a character vector or a line style code. Default: <b>'-'</b>.</p>
+  <p><b>'FaceAlpha'</b>: transparency of the filled shape. FaceAlpha can be a scalar between 0 and 1. Default: <b>1</b>.</p>
+  <p><b>'EdgeAlpha'</b>: transparency of the edges of the polygonal shape. EdgeAlpha can be a scalar between 0 and 1. Default: <b>1</b>.</p>
+  <p><b>'Parent'</b>: handle of the parent object for the patch. Default: <b>gca()</b>.</p>
+  <p><b>'Vertices'</b>: matrix of vertex coordinates. The matrix must have size N-by-2 or N-by-3, where N is the number of vertices. Default: the vertex coordinates are specified by the <b>X</b>, <b>Y</b>, and <b>Z</b> input arguments.</p>
+
+## Examples
+
+```matlab
+fig = figure('Color', 'k');
+ax.Color = 'k';
+f=0.1;
+t=0:f^2:2*pi;
+r=pi/4;
+p=r*t+r;
+patch([cos(p), 0], [sin(p), 0], 'y');
+c = eye(3);
+for a=2:2:6
+  patch([t/4+a, a+r*(1+cos(t/2)),a], [-f*cos(3*(a+t))-r,r*sin(t/2),-1], c(a/2,:));
+  patch(a +f*cos(t)'+r./[1,0.65], f*(2+sin(t)').*[1,1], 'k', 'EdgeColor', 'w', 'LineWidth', pi)
+end
+axis equal
+axis off
+```
+
+<img src="patch_1_57E1B5A6.svg" align="middle"/>
+
+```matlab
+f =figure('Color', 'w');
+x = [-1 1 0 -1];
+y = [-1/sqrt(3) -1/sqrt(3) 2*sqrt(3)/3 -1/sqrt(3)];
+plot(x,y,'k','LineWidth',3);
+t = 0:0.001:2*pi;
+xc = cos(t)/3+x';
+yc = sin(t)/3-y';
+for i = 1:3
+    patch(xc(i,:),yc(i,:),'k');
+end
+patch(x,-y,'w','EdgeColor','w');
+axis('equal')
+axis('off')
+```
+
+<img src="patch_2_242108D8.svg" align="middle"/>
+
+## See also
+
+[surf](surf.md), [colormap](colormap.md).
+
+## History
+
+| Version | Description     |
+| ------- | --------------- |
+| 1.0.0   | initial version |
+
+## Author
+
+Allan CORNET
diff --git a/en/graphics/patch_1_57E1B5A6.svg b/en/graphics/patch_1_57E1B5A6.svg
diff --git a/en/graphics/patch_2_242108D8.svg b/en/graphics/patch_2_242108D8.svg
diff --git a/en/graphics/text.md b/en/graphics/text.md
diff --git a/en/graphics/validatecolor.md b/en/graphics/validatecolor.md
diff --git a/fr/README.md b/fr/README.md
diff --git a/fr/changelogs/CHANGELOG.md b/fr/changelogs/CHANGELOG.md
