Cursor rule

1---
2description: ml-cpp coding conventions and cross-platform considerations
3globs: "**/*.cc", "**/*.h"
4---
5 
6# ml-cpp Coding Conventions
7 
8## Naming
9 
10- Classes: `CUpperCamelCase` (C prefix)
11- Methods: `lowerCamelCase`
12- Member variables: `m_UpperCamelCase`
13- Static member variables: `ms_UpperCamelCase`
14- Types: `TUpperCamelCase` (T prefix for typedefs)
15- Test files: `CClassNameTest.cc`
16- Namespaces: `ml::module::submodule`
17 
18## Commit Messages
19 
20Format: `[ML] Short description` — 1-2 sentences explaining the "why".
21 
22## Boost Test Framework
23 
24- Tests use `BOOST_AUTO_TEST_SUITE` / `BOOST_AUTO_TEST_CASE`
25- `BOOST_TEST_DONT_PRINT_LOG_VALUE` for types without operator<<
26- JUnit output: `boost_test_results.junit` per test suite
27- Seeded RNG: `maths::common::CSampling::seed()` at test start
28 
29## Cross-Platform Considerations
30 
31### Stream/IO
32- `std::istream::eof()` behaves differently across platforms
33- Use `peek() == std::char_traits<char>::eof()` for portable end-of-stream detection
34- `CJsonStateRestoreTraverser::isEof()` uses both checks for portability
35 
36### Timing in Tests
37- **Never use wall-clock time** (`CStopWatch`, `CLOCK_MONOTONIC`) for performance assertions in unit tests — flaky under parallel execution
38- Use `std::clock()` (CPU time) for scaling/benchmark assertions
39- `std::clock()` measures process CPU time on all platforms (POSIX + Windows)
40 
41### Temporary Files in Tests
42- Use process ID (`ml::core::CProcess::instance().id()`) for unique temp names
43- Do NOT use small random ranges (e.g. `1-100`) — causes collisions under parallel CTest
44 
45### Unity Build Conflicts
46- Anonymous-namespace constants (`EMPTY_STRING`, `*_TAG`) cause redefinition errors
47- Fix: rename to be unique, or add file to `SKIP_UNITY_BUILD_INCLUSION`
48- `BOOST_TEST_DONT_PRINT_LOG_VALUE` macros also conflict in unity builds
49 
50## RAII Patterns
51 
52- `std::unique_ptr` with custom deleters for resource cleanup
53- Use `reset()` not `release()` + manual cleanup — avoids leaks on exception paths
54- `CStateFileRemover` is the RAII helper for state file deletion
55