From 5d6dc201281a408d757b910e44d4843fcbd37b48 Mon Sep 17 00:00:00 2001 From: Ioana Ghiban Date: Fri, 19 Jan 2024 19:03:25 +0100 Subject: [PATCH 1/2] [doc] Fix documentation for saturating_add --- intrinsiccv/include/intrinsiccv.h | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/intrinsiccv/include/intrinsiccv.h b/intrinsiccv/include/intrinsiccv.h index e006269f0..c5289e81a 100644 --- a/intrinsiccv/include/intrinsiccv.h +++ b/intrinsiccv/include/intrinsiccv.h @@ -25,8 +25,7 @@ extern "C" { /// /// The addition is saturated, i.e. the result is the largest number of the /// type of the element if the addition result would overflow. Source data -/// length (in bytes) is `stride` * `height`, it must be the same for the two -/// sources. +/// length (in bytes) is `stride` * `height`. /// /// @param src_a Pointer to the first source data. Must be non-null. /// @param src_b Pointer to the second source data. Must be non-null. -- GitLab From db770b63402edecd517dab0990d8a714092bb499 Mon Sep 17 00:00:00 2001 From: Ioana Ghiban Date: Fri, 19 Jan 2024 18:28:05 +0000 Subject: [PATCH 2/2] Update intrinsiccv.h --- intrinsiccv/include/intrinsiccv.h | 21 +++++++++++---------- 1 file changed, 11 insertions(+), 10 deletions(-) diff --git a/intrinsiccv/include/intrinsiccv.h b/intrinsiccv/include/intrinsiccv.h index c5289e81a..58359ac5c 100644 --- a/intrinsiccv/include/intrinsiccv.h +++ b/intrinsiccv/include/intrinsiccv.h @@ -25,20 +25,21 @@ extern "C" { /// /// The addition is saturated, i.e. the result is the largest number of the /// type of the element if the addition result would overflow. Source data -/// length (in bytes) is `stride` * `height`. +/// length (in bytes) is `stride` * `height`. Width and height are the same +/// for the two sources. /// /// @param src_a Pointer to the first source data. Must be non-null. /// @param src_b Pointer to the second source data. Must be non-null. -/// @param src_a_stride Distance in bytes between the row first elements for -/// the first source data. Must not be less than -/// width * sizeof(type). -/// @param src_b_stride Distance in bytes between the row first elements for -/// the second source data. Must not be less than -/// width * sizeof(type). +/// @param src_a_stride Distance in bytes from the start of one row to the +/// start of the next row for the src_a. +/// Must not be less than width * sizeof(type). +/// @param src_b_stride Distance in bytes from the start of one row to the +/// start of the next row for the src_b. +/// Must not be less than width * sizeof(type). /// @param dst Pointer to the destination data. Must be non-null. -/// @param dst_stride Distance in bytes between the row first elements for -/// the destination data. Must not be less than -/// width * sizeof(type). +/// @param dst_stride Distance in bytes from the start of one row to the +/// start of the next row for the destination. +/// Must not be less than width * sizeof(type). /// @param width How many elements are in a row /// @param height How many rows are in the data /// -- GitLab