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-08 01:22:19 +07:00
parent f8f6b07c81
commit e15070ce45
20 changed files with 316 additions and 135 deletions
Download patch file Download diff file Expand all files Collapse all files

107
docs/vector2-rus.md
View file

@ -20,105 +20,14 @@
## Функции
### Указание координат двумерного вектора
| Функции для BgcVector2FP32 | Функции для BgcVector2FP64 |
|:-------------------------------------------------------------:|:-------------------------------------------------------------:|
| [bgc_vector2_reset_fp32](vector2/reset-rus.md) | [bgc_vector2_reset_fp64](vector2/reset-rus.md) |
| [bgc_vector2_set_values_fp32](vector2/set-values-rus.md) | [bgc_vector2_set_values_fp64](vector2/set-values-rus.md) |
| [bgc_vector2_copy_fp32](vector2/copy-rus.md) | [bgc_vector2_copy_fp64](vector2/copy-rus.md) |
| [bgc_vector2_swap_fp32](vector2/swap-rus.md) | [bgc_vector2_swap_fp64](vector2/swap-rus.md) |
Для прямого указания координат предлагаются следующие две функции:
inline void bgc_vector2_set_values_fp32(const float x1, const float x2, BgcVector2FP32* to);
inline void bgc_vector2_set_values_fp64(const double x1, const double x2, BgcVector2FP64* to);
Каждая из данных функции эквивалентна следующим строкам кода:
vector->x1 = x1;
vector->x2 = x2;
В данные функции не следует передавать некорректные указатели. Значение NULL (0)
в качестве параметра также считается некорректным.
Пример применения:
#include <stdio.h>
#include <basic-geometry.h>
int main()
{
BgcVector2FP32 my_vector;
bgc_vector2_set_values_fp32(-2, 7, &my_vector);
printf("x1 = %f, x2 = %f\n", my_vector.x1, my_vector.x2);
return 0;
}
### Копирование
Функции копирования позволяют
Для копирования координат векторов предлагаются данные функции:
inline void bgc_vector2_copy_fp32(const BgcVector2FP32* from, BgcVector2FP32* to);
inline void bgc_vector2_copy_fp64(const BgcVector2FP64* from, BgcVector2FP64* to);
Каждая из данных функции эквивалентна следующим строкам кода:
to->x1 = from->x1;
to->x2 = from->x2;
В данные функции не следует передавать некорректные указатели. Значение NULL (0)
в качестве параметра также считается некорректным.
Пример применения:
#include <stdio.h>
#include <basic-geometry.h>
int main()
{
BgcVector2FP32 my_vector1, my_vector2;
bgc_vector2_set_values_fp32(-2, 7, &my_vector1);
bgc_vector2_copy_fp32(&my_vector1, &my_vector2);
printf("x1 = %f, x2 = %f\n", my_vector2.x1, my_vector2.x2);
return 0;
}
### Обмен
Функции обмена позволяют двум векторам одного типа обменяться значениями
координат.
Для обмена значениями координат векторов определены следующие функции:
inline void bgc_vector2_swap_fp32(BgcVector2FP32* vector1, BgcVector2FP32* vector2);
inline void bgc_vector2_swap_fp64(BgcVector2FP64* vector1, BgcVector2FP64* vector2);
В данные функции не следует передавать некорректные указатели. Значение NULL (0)
также считается некорректным.
Пример применения:
#include <stdio.h>
#include <basic-geometry.h>
int main()
{
BgcVector2FP32 my_vector1, my_vector2;
bgc_vector2_set_values_fp32(-2, 7, &my_vector1);
bgc_vector2_set_values_fp32(10, -1, &my_vector2);
bgc_vector2_swap_fp32(&my_vector1, &my_vector2);
printf("Vector #1: x1 = %f, x2 = %f\n", my_vector1.x1, my_vector1.x2);
printf("Vector #2: x1 = %f, x2 = %f\n", my_vector2.x1, my_vector2.x2);
return 0;
}
### Конвертация типа
### Функции кнвертации типа
Функции конвертации типа позволяют преобразовать
@ -133,4 +42,4 @@
Тем не менее, в библиотеке есть функции, которые позволяют преобразовать данные
одного типа в данные другого типа.
[Назад](intro-rus.md)
[Документация](intro-rus.md)