Skip to content

Commit

Permalink
📝 Updated doc for vector normalization factor
Browse files Browse the repository at this point in the history
  • Loading branch information
VForiel committed Aug 3, 2023
1 parent e2efd12 commit 451ec92
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions docs/modules/vector.md
Original file line number Diff line number Diff line change
Expand Up @@ -223,18 +223,26 @@ Inputs
: The entities for which the vector will be normalized

(scores) `@s bs.vector.[x,y,z]`
: The vector components
: The initial vector ($V_i$) components

```{admonition} Config
:class: dropdown

You can configure the length of normalization (which is 1000 by default) by setting the score `vector.normalize.length bs.data` score to the desired value and giving the tag `bs.config.override` to the entity executing the function. Be careful, without this tag, the config score will be reseted to the default value.
```

Option

: (score) `@s bs.opt.0` (default: 1000)
: The length of the normalized vector shifted by 3 digits

Outputs

: (scores) `@s bs.vector.[x,y,z]`
: The normalized vector components
: The normalized vector ($V_n$) components

(score) `@s bs.out.0`
: The normalisation factor $A$ ($V_i = A \times V_n$) shifted by 3 digits

```{admonition} Performance tip
:class: tip
Expand Down Expand Up @@ -264,17 +272,19 @@ Inputs
(scores) `@s bs.vector.[x,y,z]`
: The vector components

```{admonition} Config
:class: dropdown
Option

You can configure the length of normalization (which is 1000 by default) by setting the score `vector.fast_normalize.length bs.data` score to the desired value and giving the tag `bs.config.override` to the entity executing the function. Be careful, without this tag, the config score will be reseted to the default value.
```
: (score) `@s bs.opt.0` (default: 1000)
: The length of the normalized vector shifted by 3 digits

Outputs

: (scores) `@s bs.vector.[x,y,z]`
: The normalized vector components

(score) `@s bs.out.0`
: The normalisation factor $A$ ($V_i = A \times V_n$) shifted by 3 digits

:::
::::

Expand Down

0 comments on commit 451ec92

Please sign in to comment.