Kimelas/bgc-c
2
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

Исправление названий в документации

Browse source
This commit is contained in:
Andrey Pokidov 2025-02-05 00:03:55 +07:00
parent c8f5a3f077
commit 847c022533
13 changed files with 104 additions and 104 deletions
Download patch file Download diff file Expand all files Collapse all files

44
docs/prefixes-eng.md
View file

@ -1,23 +1,23 @@
# Prefixes
# Prefixes and Suffixes
The library uses prefixes in names of types, constants and functions.
The main prefix is **BG** which means **B**asic **G**eometry.
The main prefix is **BGC** which means **B**asic **G**eometric **C**omputations.
The structure types have prefix in the form **Bg**. For example: BgFP64Vector3,
BgFP32Versor, BgFP32Matrix2x2.
The structure types have prefix in the form **Bgc**. For example: BgcVector3FP64,
BgcVersorFP32, BgcMatrix2x2FP32.
The constants have prefix in the form **BG_**. For example: BG_FP32_EPSYLON,
BG_FP64_TWO_PI.
The constants have prefix in the form **BGC_**. For example: BGC_EPSYLON_FP32,
BGC_TWO_PI_FP64.
The functions have prefix in the form **bg_**. For example:
bg_fp32_versor_combine, bg_fp64_matrix3x3_subtract.
The functions have prefix in the form **bgc_**. For example:
bgc_versor_combine_fp32, bgc_matrix3x3_subtract_fp32.
A prefix of type follows right after the prefix of the library. The library uses
two types of floating point numbers: **float** and **double** (**binary32**
and **binary64** types of the **IEEE 754** standard).
Suffixs of type ends the names of constats, types and functions of the library.
The library uses two types of floating point numbers: **float** and **double**
(**binary32** and **binary64** types of the **IEEE 754** standard).
Thus there are two prefixes of types:
Thus there are two suffixes of types:
* **FP32** - means **F**loating **P**oint, **32** bit, which corresponds to the
**float** type of the C language.
@ -26,19 +26,19 @@ Thus there are two prefixes of types:
**double** type of the C language.
The types of structures which are based in the **float** type have **FP32** as
the type prefix: BgFP32Vector3, BgFP32Matrix3x2, BgFP32Quaternion
the type prefix: BgcVector3FP32, BgcMatrix3x2FP32, BgcQuaternionFP32.
The types of structures which are based in the **double** type have **FP64** as
the type prefix: BgFP64Vector2, BgFP64Matrix2x3, BgFP64Versor
the type prefix: BgcVector2FP64, BgcMatrix2x3FP64, BgcVersorFP64.
The constants of the **float** type have **FP32_** as the type prefix:
BG_FP32_PI, BG_FP32_EPSYLON.
The constants of the **float** type have **_FP32** as the type suffix:
BGC_PI_FP32, BGC_EPSYLON_FP32.
The constants of the **double** type have **FP64_** as the type prefix:
BG_FP64_HALF_PI, BG_FP64_ONE_THIRD.
The constants of the **double** type have **_FP64** as the type suffix:
BGC_HALF_PI_FP64, BGC_ONE_THIRD_FP64.
The functions which works with data of the **float** type have **fp32_** as
the type prefix: bg_fp32_vector2_get_module, bg_fp32_radians_to_degrees.
The functions which works with data of the **float** type have **_fp32** as
the type suffix: bgc_vector2_get_modulus_fp64, bgc_radians_to_degrees_fp32.
The functions which works with data of the **double** type have **fp64_** as
the type prefix: bg_fp64_vector3_reset, bg_fp64_radians_normalize.
The functions which works with data of the **double** type have **_fp64** as
the type suffix: bgc_vector3_reset_fp64, bgc_radians_normalize_fp64.