Skip to content

Commit 6961232

Browse files
committed
doc update
1 parent ce9cc9c commit 6961232

File tree

2 files changed

+5
-16
lines changed

2 files changed

+5
-16
lines changed

ChangeLog.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
### Whats new in **v0.9.8**
2+
* Removed `set_num_threads`/`get_num_threads`. Threading is controlled by `num_threads` parameter in `find_line_segment_groups`.
3+
14
### Whats new in **v0.9.7**
25
* Thread safety in RANSAC improved
36
* `release_line_segments` takes ptr to `LineSegment*` and sets the pointer to 0 after delete

doc/cpp_api.md

Lines changed: 2 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -110,28 +110,13 @@ These search space constraints are important for
110110

111111
## Interface
112112

113-
### `set_num_threads`
114-
115-
```c++
116-
void set_num_threads(int t);
117-
```
118-
119-
Sets the number of threads used by the library. This setting does not affect OpenMP number of threads. Internally, it only sets a variable used by parallel regions. Setting `t` to negative value (or to `1`) disables threading altogether. Setting to `0` forces global OpenMP number of threads (as set by `omp_set_num_threads`). Setting any positive value sets the number of threads (capped by `omp_max_threads`).
120-
121-
### `get_num_threads`
122-
123-
```c++
124-
int get_num_threads();
125-
```
126-
127-
Returns the internal number of threads. Default value is `0`.
128-
129113
### `find_line_segment_groups`
130114

131115
```c++
132116
LineSegment * find_line_segment_groups(
133117
InputPixelType * buffer, int width, int height, int stride,
134118
float min_length, bool refine,
119+
int num_threads,
135120
int * n_lines);
136121
```
137122
@@ -142,6 +127,7 @@ Detect line segment in an image. The format of the image buffer is defined in th
142127
* **stride** - Step between rows in `float` elements
143128
* **min_length** - Minimal length of detected line
144129
* **refine** (experimental) - Line refinement - connect close lines
130+
* **num_threads** - Number of threads to use
145131
* **n_lines** - Output parameter for the number of lines.
146132
147133
The function returns an allocated array of `LineSegment` structures. The number of lines in stored in `n_lines`. These lines can be freely modified or filtered. The array must be released by `release_line_segments`.

0 commit comments

Comments
 (0)