From cdf6efb2f23cc623df295be3d5472d21e05744fd Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E3=81=93=E3=81=AE=E4=B8=AD=E4=BA=8C=E7=97=85=E3=81=AB?= =?UTF-8?q?=E7=88=86=E7=84=94=E3=82=92=EF=BC=81?= Date: Thu, 25 Jan 2024 11:30:14 +0800 Subject: [PATCH] update documents msbuild --- @export/Environment.d.ts | 6 ++++++ @export/Math.d.ts | 10 +++++++++- man/Darwinism/Environment/Environment.md | 4 ++-- man/Darwinism/Environment/Environment/set_threads.1 | 10 +++++++++- man/Darwinism/Math/Math.md | 4 ++-- man/Darwinism/Math/Math/average_distance.1 | 13 ++++++++++++- vignettes/Darwinism/Environment.html | 8 ++++---- vignettes/Darwinism/Environment/set_threads.html | 9 ++++++--- vignettes/Darwinism/Math.html | 8 ++++---- vignettes/Darwinism/Math/average_distance.html | 13 ++++++++++--- 10 files changed, 64 insertions(+), 21 deletions(-) diff --git a/@export/Environment.d.ts b/@export/Environment.d.ts index 23079a8..6fd4e7c 100644 --- a/@export/Environment.d.ts +++ b/@export/Environment.d.ts @@ -5,9 +5,15 @@ // ref=Darwinism.Env@Darwinism, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null /** + * the IPC parallel environment + * */ declare namespace Environment { /** + * set the parallel batch threads + * + * + * @param n_threads - */ function set_threads(n_threads: object): any; } diff --git a/@export/Math.d.ts b/@export/Math.d.ts index 8f19f9b..a6618ea 100644 --- a/@export/Math.d.ts +++ b/@export/Math.d.ts @@ -5,10 +5,18 @@ // ref=Darwinism.Math@Darwinism, Version=1.0.0.0, Culture=neutral, PublicKeyToken=null /** + * math helpers + * */ declare namespace Math { /** - * @param env default value Is ``null``. + * measure the average distance for the given dataset + * + * + * @param x - + * @param env - + * + * + default value Is ``null``. */ function average_distance(x: any, env?: object): number; } diff --git a/man/Darwinism/Environment/Environment.md b/man/Darwinism/Environment/Environment.md index 491acb8..6c53c10 100644 --- a/man/Darwinism/Environment/Environment.md +++ b/man/Darwinism/Environment/Environment.md @@ -1,5 +1,5 @@ # Environment +the IPC parallel environment - -+ [set_threads](Environment/set_threads.1) ++ [set_threads](Environment/set_threads.1) set the parallel batch threads diff --git a/man/Darwinism/Environment/Environment/set_threads.1 b/man/Darwinism/Environment/Environment/set_threads.1 index 8eecb10..87425e3 100644 --- a/man/Darwinism/Environment/Environment/set_threads.1 +++ b/man/Darwinism/Environment/Environment/set_threads.1 @@ -1,9 +1,17 @@ .\" man page create by R# package system. .TH ENVIRONMENT 1 2000-Jan "set_threads" "set_threads" .SH NAME -set_threads \- +set_threads \- set the parallel batch threads .SH SYNOPSIS \fIset_threads(\fBn_threads\fR as integer);\fR +.SH DESCRIPTION +.PP +set the parallel batch threads +.PP +.SH OPTIONS +.PP +\fBn_threads\fB \fR\- -. +.PP .SH SEE ALSO Environment .SH FILES diff --git a/man/Darwinism/Math/Math.md b/man/Darwinism/Math/Math.md index 15db337..1236708 100644 --- a/man/Darwinism/Math/Math.md +++ b/man/Darwinism/Math/Math.md @@ -1,5 +1,5 @@ # Math +math helpers - -+ [average_distance](Math/average_distance.1) ++ [average_distance](Math/average_distance.1) measure the average distance for the given dataset diff --git a/man/Darwinism/Math/Math/average_distance.1 b/man/Darwinism/Math/Math/average_distance.1 index a1c78ca..84781f6 100644 --- a/man/Darwinism/Math/Math/average_distance.1 +++ b/man/Darwinism/Math/Math/average_distance.1 @@ -1,10 +1,21 @@ .\" man page create by R# package system. .TH MATH 1 2000-Jan "average_distance" "average_distance" .SH NAME -average_distance \- +average_distance \- measure the average distance for the given dataset .SH SYNOPSIS \fIaverage_distance(\fBx\fR as any, [\fB\fR]);\fR +.SH DESCRIPTION +.PP +measure the average distance for the given dataset +.PP +.SH OPTIONS +.PP +\fBx\fB \fR\- -. +.PP +.PP +\fBenv\fB \fR\- -. +.PP .SH SEE ALSO Math .SH FILES diff --git a/vignettes/Darwinism/Environment.html b/vignettes/Darwinism/Environment.html index dc9a5d1..5fca0e0 100644 --- a/vignettes/Darwinism/Environment.html +++ b/vignettes/Darwinism/Environment.html @@ -10,7 +10,7 @@ - + @@ -63,10 +63,10 @@ table caption {font-size:14px;font-weight:bolder;}

require(Darwinism); -

{$desc_comments}
imports "Environment" from "Darwinism"; +

#' the IPC parallel environment
imports "Environment" from "Darwinism";

-

+

the IPC parallel environment

@@ -85,7 +85,7 @@ table caption {font-size:14px;font-weight:bolder;} set_threads - +

set the parallel batch threads

diff --git a/vignettes/Darwinism/Environment/set_threads.html b/vignettes/Darwinism/Environment/set_threads.html index f9ab73a..814e496 100644 --- a/vignettes/Darwinism/Environment/set_threads.html +++ b/vignettes/Darwinism/Environment/set_threads.html @@ -2,7 +2,7 @@ - set_threads + set the parallel batch threads @@ -18,11 +18,11 @@ -

set_threads

+

set the parallel batch threads

Description

- set_threads +

Usage

@@ -34,6 +34,9 @@ +
n.threads
+

-

+
diff --git a/vignettes/Darwinism/Math.html b/vignettes/Darwinism/Math.html index 90f8e32..409c906 100644 --- a/vignettes/Darwinism/Math.html +++ b/vignettes/Darwinism/Math.html @@ -10,7 +10,7 @@ - + @@ -63,10 +63,10 @@ table caption {font-size:14px;font-weight:bolder;}

require(Darwinism); -

{$desc_comments}
imports "Math" from "Darwinism"; +

#' math helpers
imports "Math" from "Darwinism";

-

+

math helpers

@@ -90,7 +90,7 @@ table caption {font-size:14px;font-weight:bolder;} average_distance - +

measure the average distance for the given dataset

diff --git a/vignettes/Darwinism/Math/average_distance.html b/vignettes/Darwinism/Math/average_distance.html index 7ab215e..e3191af 100644 --- a/vignettes/Darwinism/Math/average_distance.html +++ b/vignettes/Darwinism/Math/average_distance.html @@ -2,7 +2,7 @@ - average_distance + measure the average distance for the given dataset @@ -18,11 +18,11 @@ -

average_distance

+

measure the average distance for the given dataset

Description

- average_distance +

Usage

@@ -34,6 +34,13 @@ +
x
+

-

+ + +
env
+

-

+