Skip to content

Commit

Permalink
docs: regenerate stdlib docs
Browse files Browse the repository at this point in the history
  • Loading branch information
lars-reimann committed Apr 12, 2024
1 parent d0dfd88 commit 195f0e2
Show file tree
Hide file tree
Showing 59 changed files with 262 additions and 262 deletions.
38 changes: 19 additions & 19 deletions docs/stdlib/safeds/data/image/containers/Image.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

A container for image data.

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="6"
class Image {
Expand Down Expand Up @@ -328,7 +328,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image with added noise. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="163"
@Pure
Expand Down Expand Up @@ -358,7 +358,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The Image with adjusted brightness. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="146"
@Pure
Expand Down Expand Up @@ -388,7 +388,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The new, adjusted image. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="203"
@Pure
Expand Down Expand Up @@ -418,7 +418,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | New image with adjusted contrast. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="183"
@Pure
Expand Down Expand Up @@ -448,7 +448,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The blurred image. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="221"
@Pure
Expand All @@ -471,7 +471,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The grayscale image. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="82"
@Pure
Expand Down Expand Up @@ -500,7 +500,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The cropped image. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="98"
@Pure
Expand Down Expand Up @@ -529,7 +529,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image with edges found. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="287"
@Pure
Expand All @@ -549,7 +549,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The flipped image. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="129"
@Pure
Expand All @@ -569,7 +569,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The flipped image. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="118"
@Pure
Expand All @@ -589,7 +589,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image with inverted colors. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="254"
@Pure
Expand All @@ -616,7 +616,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image with the given width and height. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="66"
@Pure
Expand All @@ -641,7 +641,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image rotated 90 degrees counter-clockwise. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="276"
@Pure
Expand All @@ -661,7 +661,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image rotated 90 degrees clockwise. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="265"
@Pure
Expand All @@ -687,7 +687,7 @@ The original image is not modified.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image sharpened by the given factor. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="240"
@Pure
Expand All @@ -708,7 +708,7 @@ Save the image as a JPEG file.
|------|------|-------------|---------|
| `path` | [`String`][safeds.lang.String] | The path to the JPEG file. | - |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="39"
@Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
Expand All @@ -728,7 +728,7 @@ Save the image as a PNG file.
|------|------|-------------|---------|
| `path` | [`String`][safeds.lang.String] | The path to the PNG file. | - |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="50"
@Impure([ImpurityReason.FileWriteToParameterizedPath("path")])
Expand All @@ -754,7 +754,7 @@ Create an image from a file.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The image. |

??? quote "Source code in `image.sdsstub`"
??? quote "Stub code in `image.sdsstub`"

```sds linenums="28"
@Impure([ImpurityReason.FileReadFromParameterizedPath("path")])
Expand Down
48 changes: 24 additions & 24 deletions docs/stdlib/safeds/data/tabular/containers/Column.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@ A column is a named collection of values.
|------|-------------|-------------|---------|
| `T` | [`Any?`][safeds.lang.Any] | - | [`Any?`][safeds.lang.Any] |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="12"
class Column<out T = Any?>(
Expand Down Expand Up @@ -308,7 +308,7 @@ Check if all values have a given property.
|------|------|-------------|
| `result1` | [`Boolean`][safeds.lang.Boolean] | True if all match. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="58"
@Pure
Expand All @@ -333,7 +333,7 @@ Check if any value has a given property.
|------|------|-------------|
| `result1` | [`Boolean`][safeds.lang.Boolean] | True if any match. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="70"
@Pure
Expand All @@ -358,7 +358,7 @@ Calculate Pearson correlation between this and another column. Both columns have
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | Correlation between the two columns. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="129"
@Pure
Expand All @@ -378,7 +378,7 @@ Return a list of all unique values in the column.
|------|------|-------------|
| `result1` | [`List<T>`][safeds.lang.List] | List of unique values in the column. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="34"
@Pure
Expand All @@ -402,7 +402,7 @@ Return column value at specified index, starting at 0.
|------|------|-------------|
| `result1` | `#!sds T` | Value at index in column. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="45"
@Pure
Expand All @@ -422,7 +422,7 @@ Return whether the column has missing values.
|------|------|-------------|
| `result1` | [`Boolean`][safeds.lang.Boolean] | True if missing values exist. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="92"
@Pure
Expand All @@ -446,7 +446,7 @@ $$
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The idness of the column. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="146"
@Pure
Expand All @@ -463,7 +463,7 @@ Return the maximum value of the column. The column has to be numerical.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The maximum value. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="154"
@Pure
Expand All @@ -480,7 +480,7 @@ Return the mean value of the column. The column has to be numerical.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The mean value. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="162"
@Pure
Expand All @@ -497,7 +497,7 @@ Return the median value of the column. The column has to be numerical.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The median value. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="170"
@Pure
Expand All @@ -514,7 +514,7 @@ Return the minimum value of the column. The column has to be numerical.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The minimum value. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="178"
@Pure
Expand All @@ -531,7 +531,7 @@ Return the ratio of missing values to the total number of elements in the column
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The ratio of missing values to the total number of elements in the column. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="186"
@Pure
Expand All @@ -549,7 +549,7 @@ Return the mode of the column.
|------|------|-------------|
| `result1` | [`List<T>`][safeds.lang.List] | Returns a list with the most common values. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="195"
@Pure
Expand All @@ -572,7 +572,7 @@ Check if no values has a given property.
|------|------|-------------|
| `result1` | [`Boolean`][safeds.lang.Boolean] | True if none match. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="82"
@Pure
Expand All @@ -591,7 +591,7 @@ Plot this column in a boxplot. This function can only plot real numerical data.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The plot as an image. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="244"
@Pure
Expand All @@ -609,7 +609,7 @@ Plot a column in a histogram.
|------|------|-------------|
| `result1` | [`Image`][safeds.data.image.containers.Image] | The plot as an image. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="253"
@Pure
Expand All @@ -635,7 +635,7 @@ The original column is not modified.
|------|------|-------------|
| `result1` | [`Column<Any?>`][safeds.data.tabular.containers.Column] | A new column with the new name. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="105"
@Pure
Expand All @@ -662,7 +662,7 @@ The stability is not defined for a column with only null values.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The stability of the column. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="211"
@Pure
Expand All @@ -679,7 +679,7 @@ Return the standard deviation of the column. The column has to be numerical.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The standard deviation of all values. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="219"
@Pure
Expand All @@ -697,7 +697,7 @@ Return the sum of the column. The column has to be numerical.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The sum of all values. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="228"
@Pure
Expand All @@ -714,7 +714,7 @@ Return an HTML representation of the column.
|------|------|-------------|
| `result1` | [`String`][safeds.lang.String] | The generated HTML. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="262"
@Pure
Expand Down Expand Up @@ -746,7 +746,7 @@ The original column is not modified.
|------|-------------|-------------|---------|
| `R` | [`Any?`][safeds.lang.Any] | - | - |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="119"
@Pure
Expand All @@ -765,7 +765,7 @@ Return the variance of the column. The column has to be numerical.
|------|------|-------------|
| `result1` | [`Float`][safeds.lang.Float] | The variance of all values. |

??? quote "Source code in `column.sdsstub`"
??? quote "Stub code in `column.sdsstub`"

```sds linenums="236"
@Pure
Expand Down
Loading

0 comments on commit 195f0e2

Please sign in to comment.