mirror of
https://github.com/HandmadeMath/HandmadeMath.git
synced 2025-12-29 16:04:33 +00:00
Compare commits
18 Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
98fffbd7cc | ||
|
|
efd9f2f4b7 | ||
|
|
c8ada18370 | ||
|
|
70ac2b7e5b | ||
|
|
924ee43923 | ||
|
|
440b885d59 | ||
|
|
98f535aeec | ||
|
|
09524f72ed | ||
|
|
be30046a5a | ||
|
|
ff4513ff33 | ||
|
|
364569abe9 | ||
|
|
a9972e71da | ||
|
|
cf606db217 | ||
|
|
67b84dece7 | ||
|
|
8e188c4b7c | ||
|
|
36fbeaeac4 | ||
|
|
666f7e3325 | ||
|
|
ad3039186d |
2
.gitignore
vendored
2
.gitignore
vendored
@@ -6,6 +6,7 @@
|
|||||||
*.lo
|
*.lo
|
||||||
*.o
|
*.o
|
||||||
*.obj
|
*.obj
|
||||||
|
*.vs
|
||||||
|
|
||||||
# Precompiled Headers
|
# Precompiled Headers
|
||||||
*.gch
|
*.gch
|
||||||
@@ -31,3 +32,4 @@
|
|||||||
*.out
|
*.out
|
||||||
*.app
|
*.app
|
||||||
hmm_test
|
hmm_test
|
||||||
|
hmm_test*
|
||||||
|
|||||||
3
.gitmodules
vendored
3
.gitmodules
vendored
@@ -1,3 +0,0 @@
|
|||||||
[submodule "externals/googletest"]
|
|
||||||
path = externals/googletest
|
|
||||||
url = https://github.com/google/googletest.git
|
|
||||||
|
|||||||
@@ -5,4 +5,8 @@ compiler:
|
|||||||
install:
|
install:
|
||||||
- cd test
|
- cd test
|
||||||
- make
|
- make
|
||||||
script: ./hmm_test
|
script:
|
||||||
|
- ./hmm_test_c
|
||||||
|
- ./hmm_test_c_no_sse
|
||||||
|
- ./hmm_test_cpp
|
||||||
|
- ./hmm_test_cpp_no_sse
|
||||||
|
|||||||
51
CONTRIBUTING.md
Normal file
51
CONTRIBUTING.md
Normal file
@@ -0,0 +1,51 @@
|
|||||||
|
# Quick style guide
|
||||||
|
|
||||||
|
* Put braces on a new line
|
||||||
|
* Float literals should have digits both before and after the decimal.
|
||||||
|
```cpp
|
||||||
|
// Good
|
||||||
|
0.0f;
|
||||||
|
0.5f;
|
||||||
|
1.0f;
|
||||||
|
3.14159f;
|
||||||
|
|
||||||
|
// Bad
|
||||||
|
1.f
|
||||||
|
.0f
|
||||||
|
```
|
||||||
|
* Put macros and return types on a separate line from the function definition:
|
||||||
|
```cpp
|
||||||
|
HINLINE float
|
||||||
|
HMM_MyFunction()
|
||||||
|
{
|
||||||
|
// ...
|
||||||
|
}
|
||||||
|
```
|
||||||
|
* Explicitly initialize variables to zero:
|
||||||
|
```cpp
|
||||||
|
HINLINE float
|
||||||
|
HMM_MyFunction()
|
||||||
|
{
|
||||||
|
float MyFloat = 0.0f;
|
||||||
|
hmm_vec3 MyVector = {0};
|
||||||
|
}
|
||||||
|
```
|
||||||
|
* Put parentheses around the returned value:
|
||||||
|
```cpp
|
||||||
|
HINLINE float
|
||||||
|
HMM_MyFunction()
|
||||||
|
{
|
||||||
|
return (1.0f);
|
||||||
|
}
|
||||||
|
```
|
||||||
|
|
||||||
|
|
||||||
|
# Other notes
|
||||||
|
|
||||||
|
* If a new function is defined with different names for different datatypes, also add C++ overloaded versions of the functions. For example, if you have `HMM_LengthVec2(hmm_vec2)` and `HMM_LengthVec3(hmm_vec3)`, also provide `HMM_Length(hmm_vec2)` and `HMM_Length(hmm_vec3)`.
|
||||||
|
|
||||||
|
It is fine for the overloaded versions to call the C versions.
|
||||||
|
* Only use operator overloading for analogous operators in C. That means `+` for vector addition is fine, but no using `^` for cross product or `|` for dot product.
|
||||||
|
* Try to define functions in the same order as the prototypes.
|
||||||
|
* Don't forget that Handmade Math uses column-major order for matrices!
|
||||||
|
|
||||||
840
HandmadeMath.h
840
HandmadeMath.h
File diff suppressed because it is too large
Load Diff
@@ -12,6 +12,13 @@ _This library is free and will stay free, but if you would like to support devel
|
|||||||
|
|
||||||
Version | Changes |
|
Version | Changes |
|
||||||
----------------|----------------|
|
----------------|----------------|
|
||||||
|
**1.2.0** | Added equality functions for `HMM_Vec2`, `HMM_Vec3`, and `HMM_Vec4`, and SSE'd `HMM_MultiplyMat4` and `HMM_Transpose`.
|
||||||
|
**1.1.5** | Added `Width` and `Height` to `HMM_Vec2`, and made it so you can supply your own `SqrtF`.
|
||||||
|
**1.1.4** | Fixed SSE being included on platforms that don't support it, and fixed divide-by-zero errors when normalizing zero vectors.
|
||||||
|
**1.1.3** | Fixed compile error in C mode
|
||||||
|
**1.1.2** | Fixed invalid HMMDEF's in the function definitions
|
||||||
|
**1.1.1** | Resolved compiler warnings on gcc and g++
|
||||||
|
**1.1** | Quaternions! |
|
||||||
**1.0** | Lots of testing |
|
**1.0** | Lots of testing |
|
||||||
**0.7** | Added HMM_Vec2, and HMM_Vec4 versions of HMM_LengthSquared, HMM_Length, and HMM_Normalize. |
|
**0.7** | Added HMM_Vec2, and HMM_Vec4 versions of HMM_LengthSquared, HMM_Length, and HMM_Normalize. |
|
||||||
**0.6** | Made HMM_Power faster, Fixed possible efficiency problem with HMM_Normalize, RENAMED HMM_LengthSquareRoot to HMM_LengthSquared, RENAMED HMM_RSqrtF to HMM_RSquareRootF, RENAMED HMM_SqrtF to HMM_SquareRootF, REMOVED Inner function (user should use Dot now), REMOVED HMM_FastInverseSquareRoot function declaration |
|
**0.6** | Made HMM_Power faster, Fixed possible efficiency problem with HMM_Normalize, RENAMED HMM_LengthSquareRoot to HMM_LengthSquared, RENAMED HMM_RSqrtF to HMM_RSquareRootF, RENAMED HMM_SqrtF to HMM_SquareRootF, REMOVED Inner function (user should use Dot now), REMOVED HMM_FastInverseSquareRoot function declaration |
|
||||||
@@ -32,7 +39,7 @@ _This library is free and will stay free, but if you would like to support devel
|
|||||||
|
|
||||||
**What's the license?**
|
**What's the license?**
|
||||||
|
|
||||||
This library is in the public domain. You can do whatever you want with them.
|
This library is in the public domain. You can do whatever you want with it.
|
||||||
|
|
||||||
**Where can I contact you to ask questions?**
|
**Where can I contact you to ask questions?**
|
||||||
|
|
||||||
|
|||||||
1
externals/googletest
vendored
1
externals/googletest
vendored
Submodule externals/googletest deleted from ed9d1e1ff9
4
test/HandmadeMath.c
Normal file
4
test/HandmadeMath.c
Normal file
@@ -0,0 +1,4 @@
|
|||||||
|
|
||||||
|
#define HANDMADE_MATH_IMPLEMENTATION
|
||||||
|
#define HANDMADE_MATH_NO_INLINE
|
||||||
|
#include "../HandmadeMath.h"
|
||||||
@@ -1,5 +1,2 @@
|
|||||||
|
#include "HandmadeMath.c"
|
||||||
#define HANDMADE_MATH_IMPLEMENTATION
|
// C++ compilers complain when compiling a .c file...
|
||||||
#define HANDMADE_MATH_CPP_MODE
|
|
||||||
#define HANDMADE_MATH_NO_INLINE
|
|
||||||
#include "../HandmadeMath.h"
|
|
||||||
|
|||||||
94
test/HandmadeTest.h
Normal file
94
test/HandmadeTest.h
Normal file
@@ -0,0 +1,94 @@
|
|||||||
|
#ifndef HANDMADETEST_H
|
||||||
|
#define HANDMADETEST_H
|
||||||
|
|
||||||
|
#include <float.h>
|
||||||
|
#include <stdio.h>
|
||||||
|
|
||||||
|
int hmt_count_tests = 0;
|
||||||
|
int hmt_count_failedtests = 0;
|
||||||
|
int hmt_count_failures = 0;
|
||||||
|
|
||||||
|
#define RESET "\033[0m"
|
||||||
|
#define RED "\033[31m"
|
||||||
|
#define GREEN "\033[32m"
|
||||||
|
|
||||||
|
#define CATEGORY_BEGIN(name) { \
|
||||||
|
int count_categorytests = 0; \
|
||||||
|
int count_categoryfailedtests = 0; \
|
||||||
|
int count_categoryfailures = 0; \
|
||||||
|
printf("\n" #name ":\n");
|
||||||
|
#define CATEGORY_END(name) \
|
||||||
|
hmt_count_tests += count_categorytests; \
|
||||||
|
hmt_count_failedtests += count_categoryfailedtests; \
|
||||||
|
hmt_count_failures += count_categoryfailures; \
|
||||||
|
printf("%d/%d tests passed, %d failures\n", count_categorytests - count_categoryfailedtests, count_categorytests, count_categoryfailures); \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define TEST_BEGIN(name) { \
|
||||||
|
int count_testfailures = 0; \
|
||||||
|
count_categorytests++; \
|
||||||
|
printf(" " #name ":");
|
||||||
|
#define TEST_END() \
|
||||||
|
count_categoryfailures += count_testfailures; \
|
||||||
|
if (count_testfailures > 0) { \
|
||||||
|
count_categoryfailedtests++; \
|
||||||
|
printf("\n"); \
|
||||||
|
} else { \
|
||||||
|
printf(GREEN " [PASS]\n" RESET); \
|
||||||
|
} \
|
||||||
|
}
|
||||||
|
|
||||||
|
#define CASE_FAIL() \
|
||||||
|
count_testfailures++; \
|
||||||
|
printf("\n - " RED "[FAIL] (%d) " RESET, __LINE__)
|
||||||
|
|
||||||
|
/*
|
||||||
|
* Asserts and expects
|
||||||
|
*/
|
||||||
|
#define EXPECT_TRUE(_actual) do { \
|
||||||
|
if (!(_actual)) { \
|
||||||
|
CASE_FAIL(); \
|
||||||
|
printf("Expected true but got something false"); \
|
||||||
|
} \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#define EXPECT_FALSE(_actual) do { \
|
||||||
|
if (_actual) { \
|
||||||
|
CASE_FAIL(); \
|
||||||
|
printf("Expected false but got something true"); \
|
||||||
|
} \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#define EXPECT_FLOAT_EQ(_actual, _expected) do { \
|
||||||
|
float actual = (_actual); \
|
||||||
|
float diff = actual - (_expected); \
|
||||||
|
if (diff < -FLT_EPSILON || FLT_EPSILON < diff) { \
|
||||||
|
CASE_FAIL(); \
|
||||||
|
printf("Expected %f, got %f", (_expected), actual); \
|
||||||
|
} \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#define EXPECT_NEAR(_actual, _expected, _epsilon) do { \
|
||||||
|
float actual = (_actual); \
|
||||||
|
float diff = actual - (_expected); \
|
||||||
|
if (diff < -(_epsilon) || (_epsilon) < diff) { \
|
||||||
|
CASE_FAIL(); \
|
||||||
|
printf("Expected %f, got %f", (_expected), actual); \
|
||||||
|
} \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#define EXPECT_LT(_actual, _expected) do { \
|
||||||
|
if ((_actual) >= (_expected)) { \
|
||||||
|
CASE_FAIL(); \
|
||||||
|
printf("Expected %f to be less than %f", (_actual), (_expected)); \
|
||||||
|
} \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#define EXPECT_GT(_actual, _expected) do { \
|
||||||
|
if ((_actual) <= (_expected)) { \
|
||||||
|
CASE_FAIL(); \
|
||||||
|
printf("Expected %f to be greater than %f", (_actual), (_expected)); \
|
||||||
|
} \
|
||||||
|
} while (0)
|
||||||
|
|
||||||
|
#endif
|
||||||
102
test/Makefile
102
test/Makefile
@@ -1,81 +1,37 @@
|
|||||||
# A sample Makefile for building Google Test and using it in user
|
ROOT_DIR=..
|
||||||
# tests. Please tweak it to suit your environment and project. You
|
|
||||||
# may want to move it to your project's root directory.
|
|
||||||
#
|
|
||||||
# SYNOPSIS:
|
|
||||||
#
|
|
||||||
# make [all] - makes everything.
|
|
||||||
# make TARGET - makes the given target.
|
|
||||||
# make clean - removes all files generated by make.
|
|
||||||
|
|
||||||
# Please tweak the following variable definitions as needed by your
|
CXXFLAGS+=-g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers
|
||||||
# project, except GTEST_HEADERS, which you can use in your own targets
|
|
||||||
# but shouldn't modify.
|
|
||||||
|
|
||||||
# Points to the root of Google Test, relative to where this file is.
|
all: c c_no_sse cpp cpp_no_sse
|
||||||
# Remember to tweak this if you move this file.
|
|
||||||
GTEST_DIR = ../externals/googletest/googletest
|
|
||||||
|
|
||||||
# Where to find user code.
|
clean:
|
||||||
USER_DIR = ..
|
rm -f hmm_test_c hmm_test_cpp hmm_test_c_no_sse hmm_test_cpp_no_sse *.o
|
||||||
|
|
||||||
# Flags passed to the preprocessor.
|
c: $(ROOT_DIR)/test/HandmadeMath.c test_impl
|
||||||
# Set Google Test's header directory as a system directory, such that
|
@echo "\nCompiling in C mode"
|
||||||
# the compiler doesn't generate warnings in Google Test headers.
|
$(CC) $(CPPFLAGS) $(CXXFLAGS) -std=c99 \
|
||||||
CPPFLAGS += -isystem $(GTEST_DIR)/include
|
-c $(ROOT_DIR)/test/HandmadeMath.c $(ROOT_DIR)/test/hmm_test.c \
|
||||||
|
-lm
|
||||||
|
$(CC) -ohmm_test_c HandmadeMath.o hmm_test.o -lm
|
||||||
|
|
||||||
# Flags passed to the C++ compiler.
|
c_no_sse: $(ROOT_DIR)/test/HandmadeMath.c test_impl
|
||||||
CXXFLAGS += -g -Wall -Wextra -pthread -Wno-missing-braces -Wno-missing-field-initializers
|
@echo "\nCompiling in C mode (no SSE)"
|
||||||
|
$(CC) $(CPPFLAGS) $(CXXFLAGS) -std=c99 \
|
||||||
|
-DHANDMADE_MATH_NO_SSE \
|
||||||
|
-c $(ROOT_DIR)/test/HandmadeMath.c $(ROOT_DIR)/test/hmm_test.c \
|
||||||
|
-lm
|
||||||
|
$(CC) -ohmm_test_c_no_sse HandmadeMath.o hmm_test.o -lm
|
||||||
|
|
||||||
# All tests produced by this Makefile. Remember to add new tests you
|
cpp: $(ROOT_DIR)/test/HandmadeMath.cpp test_impl
|
||||||
# created to the list.
|
@echo "\nCompiling in C++ mode"
|
||||||
TESTS = hmm_test
|
$(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp \
|
||||||
|
-DHANDMADE_MATH_CPP_MODE \
|
||||||
|
$(ROOT_DIR)/test/HandmadeMath.cpp $(ROOT_DIR)/test/hmm_test.cpp
|
||||||
|
|
||||||
# All Google Test headers. Usually you shouldn't change this
|
cpp_no_sse: $(ROOT_DIR)/test/HandmadeMath.cpp test_impl
|
||||||
# definition.
|
@echo "\nCompiling in C++ mode (no SSE)"
|
||||||
GTEST_HEADERS = $(GTEST_DIR)/include/gtest/*.h \
|
$(CXX) $(CPPFLAGS) $(CXXFLAGS) -ohmm_test_cpp_no_sse \
|
||||||
$(GTEST_DIR)/include/gtest/internal/*.h
|
-DHANDMADE_MATH_CPP_MODE -DHANDMADE_MATH_NO_SSE \
|
||||||
|
$(ROOT_DIR)/test/HandmadeMath.cpp $(ROOT_DIR)/test/hmm_test.cpp
|
||||||
|
|
||||||
# House-keeping build targets.
|
test_impl: $(ROOT_DIR)/test/hmm_test.cpp $(ROOT_DIR)/test/hmm_test.c
|
||||||
|
|
||||||
all : $(TESTS)
|
|
||||||
|
|
||||||
clean :
|
|
||||||
rm -f $(TESTS) gtest.a gtest_main.a *.o
|
|
||||||
|
|
||||||
# Builds gtest.a and gtest_main.a.
|
|
||||||
|
|
||||||
# Usually you shouldn't tweak such internal variables, indicated by a
|
|
||||||
# trailing _.
|
|
||||||
GTEST_SRCS_ = $(GTEST_DIR)/src/*.cc $(GTEST_DIR)/src/*.h $(GTEST_HEADERS)
|
|
||||||
|
|
||||||
# For simplicity and to avoid depending on Google Test's
|
|
||||||
# implementation details, the dependencies specified below are
|
|
||||||
# conservative and not optimized. This is fine as Google Test
|
|
||||||
# compiles fast and for ordinary users its source rarely changes.
|
|
||||||
gtest-all.o : $(GTEST_SRCS_)
|
|
||||||
$(CXX) $(CPPFLAGS) -I$(GTEST_DIR) $(CXXFLAGS) -c \
|
|
||||||
$(GTEST_DIR)/src/gtest-all.cc
|
|
||||||
|
|
||||||
gtest_main.o : $(GTEST_SRCS_)
|
|
||||||
$(CXX) $(CPPFLAGS) -I$(GTEST_DIR) $(CXXFLAGS) -c \
|
|
||||||
$(GTEST_DIR)/src/gtest_main.cc
|
|
||||||
|
|
||||||
gtest.a : gtest-all.o
|
|
||||||
$(AR) $(ARFLAGS) $@ $^
|
|
||||||
|
|
||||||
gtest_main.a : gtest-all.o gtest_main.o
|
|
||||||
$(AR) $(ARFLAGS) $@ $^
|
|
||||||
|
|
||||||
# Builds a sample test. A test should link with either gtest.a or
|
|
||||||
# gtest_main.a, depending on whether it defines its own main()
|
|
||||||
# function.
|
|
||||||
|
|
||||||
HandmadeMath.o : $(USER_DIR)/test/HandmadeMath.cpp $(USER_DIR)/HandmadeMath.h $(GTEST_HEADERS)
|
|
||||||
$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(USER_DIR)/test/HandmadeMath.cpp
|
|
||||||
|
|
||||||
hmm_test.o : $(USER_DIR)/test/hmm_test.cpp $(GTEST_HEADERS)
|
|
||||||
$(CXX) $(CPPFLAGS) $(CXXFLAGS) -c $(USER_DIR)/test/hmm_test.cpp
|
|
||||||
|
|
||||||
hmm_test : HandmadeMath.o hmm_test.o gtest_main.a
|
|
||||||
$(CXX) $(CPPFLAGS) $(CXXFLAGS) -lpthread $^ -o $@
|
|
||||||
|
|||||||
11
test/README.md
Normal file
11
test/README.md
Normal file
@@ -0,0 +1,11 @@
|
|||||||
|
# Testing
|
||||||
|
|
||||||
|
You can compile and run the tests yourself by running:
|
||||||
|
|
||||||
|
```
|
||||||
|
make
|
||||||
|
./hmm_test_c
|
||||||
|
./hmm_test_c_no_sse
|
||||||
|
./hmm_test_cpp
|
||||||
|
./hmm_test_cpp_no_sse
|
||||||
|
```
|
||||||
2202
test/hmm_test.c
Normal file
2202
test/hmm_test.c
Normal file
File diff suppressed because it is too large
Load Diff
1438
test/hmm_test.cpp
1438
test/hmm_test.cpp
File diff suppressed because it is too large
Load Diff
Reference in New Issue
Block a user