From 3932f83720e1401efd8c281cb5818952d059f4b3 Mon Sep 17 00:00:00 2001 From: Andrey Pokidov Date: Sat, 23 Nov 2024 01:25:52 +0700 Subject: [PATCH] =?UTF-8?q?=D0=9D=D0=B5=D0=B1=D0=BE=D0=BB=D1=8C=D1=88?= =?UTF-8?q?=D0=B8=D0=B5=20=D0=B8=D1=81=D0=BF=D1=80=D0=B0=D0=B2=D0=BB=D0=B5?= =?UTF-8?q?=D0=BD=D0=B8=D1=8F=20=D0=B2=20=D0=B4=D0=BE=D0=BA=D1=83=D0=BC?= =?UTF-8?q?=D0=B5=D0=BD=D1=82=D0=B0=D1=86=D0=B8=D0=B8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- docs/english/Angle.md | 7 +++---- docs/english/Prefixes.md | 10 +++++----- docs/russian/Angle.md | 14 +++++++++----- 3 files changed, 17 insertions(+), 14 deletions(-) diff --git a/docs/english/Angle.md b/docs/english/Angle.md index eb5147c..862d15e 100644 --- a/docs/english/Angle.md +++ b/docs/english/Angle.md @@ -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 diff --git a/docs/english/Prefixes.md b/docs/english/Prefixes.md index 3f2772f..4d0292a 100644 --- a/docs/english/Prefixes.md +++ b/docs/english/Prefixes.md @@ -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** diff --git a/docs/russian/Angle.md b/docs/russian/Angle.md index b41bfa8..a8502db 100644 --- a/docs/russian/Angle.md +++ b/docs/russian/Angle.md @@ -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] оборотов