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 2024-11-23 01:25:52 +07:00
parent eaf12b0a08
commit 3932f83720
3 changed files with 17 additions and 14 deletions
Download patch file Download diff file Expand all files Collapse all files

7
docs/english/Angle.md
View file

@ -4,7 +4,7 @@ There are no structures for angles in the library. The library represents
angles as floating point numbers of types **float** and **double**.
There are three units of measurement for angles in the library:
* radians (the full round is equal to 2∏ radians)
* radians (the full round is equal to 2π radians)
* degrees (the full round is equal to 360 degrees)
* turns (the full round is equal to 1 turn)
@ -16,7 +16,6 @@ The units of measurement of angles are defined with an enumerated type:
BG_ANGLE_UNIT_TURNS = 3
} angle_unit_t;
* BG_ANGLE_UNIT_RADIANS is for measurement of angles in radians
* BG_ANGLE_UNIT_DEGREES is for measurement of angles in degrees
* BG_ANGLE_UNIT_TURNS is for measurement of angles in turns
@ -28,13 +27,13 @@ There are two ranges of normalized angles: a signed range and an unsigned
range.
The unsigned range has no negative values. The unsigned range corresponds:
* [0, 2∏) radians
* [0, 2π) radians
* [0, 360) degrees
* [0, 1) turns
The signed range has both positive and negative values. The signed range
corresponds:
* (-∏, ∏] radians
* (-π, π] radians
* (-180, 180] degrees
* (-0.5, 0.5] turns

10
docs/english/Prefixes.md
View file

@ -4,14 +4,14 @@ The library uses prefixes in names of types, constants and functions.
The main prefix is **BG** which means **B**asic **G**eometry.
The structure types have prefix in the form **Bg**. For example: *BgFP64Vector3*,
*BgFP32Versor*, *BgFP32Matrix2x2*.
The structure types have prefix in the form **Bg**. For example: BgFP64Vector3,
BgFP32Versor, BgFP32Matrix2x2.
The constants have prefix in the form **BG_**. For example: *BG_FP32_EPSYLON*,
*BG_FP64_TWO_PI*.
The constants have prefix in the form **BG_**. For example: BG_FP32_EPSYLON,
BG_FP64_TWO_PI.
The functions have prefix in the form **bg_**. For example:
*bg_fp32_versor_combine*, *bg_fp64_matrix3x3_subtract*.
bg_fp32_versor_combine, bg_fp64_matrix3x3_subtract.
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**

14
docs/russian/Angle.md
View file

@ -5,7 +5,7 @@
типов **float** и **double**.
В библиотеке есть три единицы измерения уголов:
* радианы (полный оборот равен 2∏ радиан)
* радианы (полный оборот равен 2π радиан)
* градусы (полный оборот равен 360 градусов)
* обороты (полный оборот равен 1)
@ -17,6 +17,10 @@
BG_ANGLE_UNIT_TURNS = 3
} angle_unit_t;
* BG_ANGLE_UNIT_RADIANS для уголов, измеряемых в радианах
* BG_ANGLE_UNIT_DEGREES для уголов, измеряемых в градусах
* BG_ANGLE_UNIT_TURNS для уголов, измеряемых в оборотах
Функции, которые принимают угол в качестве параметра, не требуют, чтобы
угол принадлежал какому-либо промежутку значений. Но в библиотеке есть
функции, которые могут нормализовать угол так, чтобы он находился в
@ -26,13 +30,13 @@
(unsigned).
Беззнаковый диапазон не содержит отрицательных значений и соответствует:
[0, 2∏) радиан
[0, 360) градусов
[0, 1) оборотов
* [0, 2π) радиан
* [0, 360) градусов
* [0, 1) оборотов
Знаковый диапазон содержит как отрицательные, так и положительные значения.
Знаковый диапазон соответствует:
* (-∏, ∏] радиан
* (-π, π] радиан
* (-180, 180] градусов
* (-0,5, 0,5] оборотов