Update changelog and docs

Author: twistedfall

CHANGES.md

@@ -1,3 +1,13 @@
+* 0.92.0
+  * Add `DoubleEndedIterator` impl for `Vector` and simplify trait bounds.
+  * Type aliases for `Vector` (`VectorOf...`), `Ptr` and `Tuple` are now deprecated.
+  * Add missing `Mat_` methods, speed up `Mat::at*()` and `Mat_::at*()` methods slightly. Allow calling `at()` method on a `Mat`
+    with more than 2 dimensions.
+  * Improved typedef generation that led to changing of some typedef names, e.g. `va_display` → `VADisplay`. Typedefed types are
+    now also preserved in function signatures.
+  * Fix several cases where returned objects were not usable and led to a segfault, e.g. `SparseMap::hdr()`.
+  * Add a helper to accommodate calling OpenCV functions that can modify a `Mat` in place, use `modify_inplace()` method.
+
 * 0.91.3
   * Add workaround for https://github.com/twistedfall/opencv-rust/issues/548.
 

docs/core.rs

@@ -2525,12 +2525,12 @@ pub mod core {
 
 	opencv_type_enum! { core::_OutputArray_DepthMask }
 
-	pub type va_display = *mut c_void;
-	pub type va_surface_id = u32;
+	pub type VADisplay = *mut c_void;
+	pub type VASurfaceID = u32;
 	pub type Affine3d = core::Affine3<f64>;
 	pub type Affine3f = core::Affine3<f32>;
-	pub type Hamming_result_type = i32;
-	pub type Hamming_value_type = u8;
+	pub type Hamming_ResultType = i32;
+	pub type Hamming_ValueType = u8;
 	pub type HammingLUT = core::Hamming;
 	pub type InputArray<'a> = &'a core::_InputArray;
 	pub type InputArrayOfArrays<'a> = core::InputArray<'a>;
@@ -11919,7 +11919,7 @@ pub mod core {
 	/// * size: - size of image represented by VASurfaceID object.
 	/// * dst: - destination OutputArray.
 	#[inline]
-	pub unsafe fn convert_from_va_surface(display: core::va_display, surface: core::va_surface_id, size: core::Size, dst: &mut impl ToOutputArray) -> Result<()> {
+	pub unsafe fn convert_from_va_surface(display: core::VADisplay, surface: core::VASurfaceID, size: core::Size, dst: &mut impl ToOutputArray) -> Result<()> {
 		output_array_arg!(dst);
 		return_send!(via ocvrs_return);
 		{ sys::cv_va_intel_convertFromVASurface_VADisplay_VASurfaceID_Size_const__OutputArrayR(display, surface, &size, dst.as_raw__OutputArray(), ocvrs_return.as_mut_ptr()) };
@@ -11935,7 +11935,7 @@ pub mod core {
 	/// * surface: - destination VASurfaceID object.
 	/// * size: - size of image represented by VASurfaceID object.
 	#[inline]
-	pub unsafe fn convert_to_va_surface(display: core::va_display, src: &impl ToInputArray, surface: core::va_surface_id, size: core::Size) -> Result<()> {
+	pub unsafe fn convert_to_va_surface(display: core::VADisplay, src: &impl ToInputArray, surface: core::VASurfaceID, size: core::Size) -> Result<()> {
 		input_array_arg!(src);
 		return_send!(via ocvrs_return);
 		{ sys::cv_va_intel_convertToVASurface_VADisplay_const__InputArrayR_VASurfaceID_Size(display, src.as_raw__InputArray(), surface, &size, ocvrs_return.as_mut_ptr()) };
@@ -11955,7 +11955,7 @@ pub mod core {
 	/// This alternative version of [initialize_context_from_va] function uses the following default values for its arguments:
 	/// * try_interop: true
 	#[inline]
-	pub unsafe fn initialize_context_from_va_def(display: core::va_display) -> Result<core::Context> {
+	pub unsafe fn initialize_context_from_va_def(display: core::VADisplay) -> Result<core::Context> {
 		return_send!(via ocvrs_return);
 		{ sys::cv_va_intel_ocl_initializeContextFromVA_VADisplay(display, ocvrs_return.as_mut_ptr()) };
 		return_receive!(ocvrs_return => ret);
@@ -11974,7 +11974,7 @@ pub mod core {
 	/// ## C++ default parameters
 	/// * try_interop: true
 	#[inline]
-	pub unsafe fn initialize_context_from_va(display: core::va_display, try_interop: bool) -> Result<core::Context> {
+	pub unsafe fn initialize_context_from_va(display: core::VADisplay, try_interop: bool) -> Result<core::Context> {
 		return_send!(via ocvrs_return);
 		{ sys::cv_va_intel_ocl_initializeContextFromVA_VADisplay_bool(display, try_interop, ocvrs_return.as_mut_ptr()) };
 		return_receive!(ocvrs_return => ret);
@@ -15956,7 +15956,7 @@ pub mod core {
 
 		/// this will count the bits in a ^ b
 		#[inline]
-		fn apply(&self, a: &[u8], b: &[u8]) -> Result<core::Hamming_result_type> {
+		fn apply(&self, a: &[u8], b: &[u8]) -> Result<core::Hamming_ResultType> {
 			return_send!(via ocvrs_return);
 			unsafe { sys::cv_Hamming_operator___const_const_unsigned_charX_const_unsigned_charX_int(self.as_raw_Hamming(), a.as_ptr(), b.as_ptr(), a.len().min(b.len()).try_into()?, ocvrs_return.as_mut_ptr()) };
 			return_receive!(unsafe ocvrs_return => ret);
@@ -32512,18 +32512,18 @@ pub mod core {
 
 		/// shape of this array
 		#[inline]
-		fn size(&self) -> core::Vector<i32> {
+		fn size(&self) -> core::GpuMatND_SizeArray {
 			let ret = unsafe { sys::cv_cuda_GpuMatND_propSize_const(self.as_raw_GpuMatND()) };
-			let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+			let ret = unsafe { core::GpuMatND_SizeArray::opencv_from_extern(ret) };
 			ret
 		}
 
 		/// ! step values
 		/// Their semantics is identical to the semantics of step for Mat.
 		#[inline]
-		fn step(&self) -> core::Vector<size_t> {
+		fn step(&self) -> core::GpuMatND_StepArray {
 			let ret = unsafe { sys::cv_cuda_GpuMatND_propStep_const(self.as_raw_GpuMatND()) };
-			let ret = unsafe { core::Vector::<size_t>::opencv_from_extern(ret) };
+			let ret = unsafe { core::GpuMatND_StepArray::opencv_from_extern(ret) };
 			ret
 		}
 

docs/dnn.rs

@@ -860,12 +860,12 @@ pub mod dnn {
 	}
 
 	#[inline]
-	pub fn concat(a: &crate::dnn::MatShape, b: &crate::dnn::MatShape) -> Result<core::Vector<i32>> {
+	pub fn concat(a: &crate::dnn::MatShape, b: &crate::dnn::MatShape) -> Result<crate::dnn::MatShape> {
 		return_send!(via ocvrs_return);
 		unsafe { sys::cv_dnn_concat_const_MatShapeR_const_MatShapeR(a.as_raw_VectorOfi32(), b.as_raw_VectorOfi32(), ocvrs_return.as_mut_ptr()) };
 		return_receive!(unsafe ocvrs_return => ret);
 		let ret = ret.into_result()?;
-		let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+		let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 		Ok(ret)
 	}
 
@@ -1863,42 +1863,42 @@ pub mod dnn {
 	}
 
 	#[inline]
-	pub fn shape_1(mat: &impl core::MatTraitConst) -> Result<core::Vector<i32>> {
+	pub fn shape_1(mat: &impl core::MatTraitConst) -> Result<crate::dnn::MatShape> {
 		return_send!(via ocvrs_return);
 		unsafe { sys::cv_dnn_shape_const_MatR(mat.as_raw_Mat(), ocvrs_return.as_mut_ptr()) };
 		return_receive!(unsafe ocvrs_return => ret);
 		let ret = ret.into_result()?;
-		let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+		let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 		Ok(ret)
 	}
 
 	#[inline]
-	pub fn shape_2(sz: &impl core::MatSizeTraitConst) -> Result<core::Vector<i32>> {
+	pub fn shape_2(sz: &impl core::MatSizeTraitConst) -> Result<crate::dnn::MatShape> {
 		return_send!(via ocvrs_return);
 		unsafe { sys::cv_dnn_shape_const_MatSizeR(sz.as_raw_MatSize(), ocvrs_return.as_mut_ptr()) };
 		return_receive!(unsafe ocvrs_return => ret);
 		let ret = ret.into_result()?;
-		let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+		let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 		Ok(ret)
 	}
 
 	#[inline]
-	pub fn shape_3(mat: &impl core::UMatTraitConst) -> Result<core::Vector<i32>> {
+	pub fn shape_3(mat: &impl core::UMatTraitConst) -> Result<crate::dnn::MatShape> {
 		return_send!(via ocvrs_return);
 		unsafe { sys::cv_dnn_shape_const_UMatR(mat.as_raw_UMat(), ocvrs_return.as_mut_ptr()) };
 		return_receive!(unsafe ocvrs_return => ret);
 		let ret = ret.into_result()?;
-		let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+		let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 		Ok(ret)
 	}
 
 	#[inline]
-	pub fn shape(dims: &i32, n: i32) -> Result<core::Vector<i32>> {
+	pub fn shape(dims: &i32, n: i32) -> Result<crate::dnn::MatShape> {
 		return_send!(via ocvrs_return);
 		unsafe { sys::cv_dnn_shape_const_intX_const_int(dims, n, ocvrs_return.as_mut_ptr()) };
 		return_receive!(unsafe ocvrs_return => ret);
 		let ret = ret.into_result()?;
-		let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+		let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 		Ok(ret)
 	}
 
@@ -1908,12 +1908,12 @@ pub mod dnn {
 	/// * a2: -1
 	/// * a3: -1
 	#[inline]
-	pub fn shape_4_def(a0: i32) -> Result<core::Vector<i32>> {
+	pub fn shape_4_def(a0: i32) -> Result<crate::dnn::MatShape> {
 		return_send!(via ocvrs_return);
 		unsafe { sys::cv_dnn_shape_int(a0, ocvrs_return.as_mut_ptr()) };
 		return_receive!(unsafe ocvrs_return => ret);
 		let ret = ret.into_result()?;
-		let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+		let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 		Ok(ret)
 	}
 
@@ -1922,12 +1922,12 @@ pub mod dnn {
 	/// * a2: -1
 	/// * a3: -1
 	#[inline]
-	pub fn shape_4(a0: i32, a1: i32, a2: i32, a3: i32) -> Result<core::Vector<i32>> {
+	pub fn shape_4(a0: i32, a1: i32, a2: i32, a3: i32) -> Result<crate::dnn::MatShape> {
 		return_send!(via ocvrs_return);
 		unsafe { sys::cv_dnn_shape_int_int_int_int(a0, a1, a2, a3, ocvrs_return.as_mut_ptr()) };
 		return_receive!(unsafe ocvrs_return => ret);
 		let ret = ret.into_result()?;
-		let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+		let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 		Ok(ret)
 	}
 
@@ -16765,9 +16765,9 @@ pub mod dnn {
 		fn as_raw_ReshapeLayer(&self) -> *const c_void;
 
 		#[inline]
-		fn new_shape_desc(&self) -> core::Vector<i32> {
+		fn new_shape_desc(&self) -> crate::dnn::MatShape {
 			let ret = unsafe { sys::cv_dnn_ReshapeLayer_propNewShapeDesc_const(self.as_raw_ReshapeLayer()) };
-			let ret = unsafe { core::Vector::<i32>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::dnn::MatShape::opencv_from_extern(ret) };
 			ret
 		}
 

docs/flann.rs

@@ -398,11 +398,11 @@ pub mod flann {
 	opencv_type_enum! { crate::flann::flann_log_level_t }
 
 	/// A bucket in an LSH table
-	pub type Bucket = core::Vector<crate::flann::feature_index>;
+	pub type Bucket = core::Vector<crate::flann::FeatureIndex>;
 	/// The id from which we can get a bucket back in an LSH table
-	pub type bucket_key = u32;
+	pub type BucketKey = u32;
 	/// What is stored in an LSH bucket
-	pub type feature_index = u32;
+	pub type FeatureIndex = u32;
 	#[inline]
 	pub fn flann_distance_type() -> Result<crate::flann::flann_distance_t> {
 		return_send!(via ocvrs_return);

docs/gapi.rs

@@ -245,10 +245,10 @@ pub mod gapi {
 	pub type GMat3 = core::Tuple<(crate::gapi::GMat, crate::gapi::GMat, crate::gapi::GMat)>;
 	pub type GMat4 = core::Tuple<(crate::gapi::GMat, crate::gapi::GMat, crate::gapi::GMat, crate::gapi::GMat)>;
 	pub type GMatScalar = core::Tuple<(crate::gapi::GMat, crate::gapi::GScalar)>;
-	pub type ImgProc_cont_method = crate::imgproc::ContourApproximationModes;
+	pub type ImgProc_ContMethod = crate::imgproc::ContourApproximationModes;
 	pub type ImgProc_GMat2 = core::Tuple<(crate::gapi::GMat, crate::gapi::GMat)>;
 	pub type ImgProc_GMat3 = core::Tuple<(crate::gapi::GMat, crate::gapi::GMat, crate::gapi::GMat)>;
-	pub type ImgProc_retr_mode = crate::imgproc::RetrievalModes;
+	pub type ImgProc_RetrMode = crate::imgproc::RetrievalModes;
 	#[inline]
 	pub fn descr_of_2(mat: &impl core::MatTraitConst) -> Result<crate::gapi::GMatDesc> {
 		return_send!(via ocvrs_return);
@@ -6886,12 +6886,12 @@ pub mod gapi {
 		/// ## C++ default parameters
 		/// * args: {}
 		#[inline]
-		fn apply(&mut self, callback: &impl crate::gapi::Detail_ExtractArgsCallbackTraitConst, mut args: crate::gapi::GCompileArgs) -> Result<core::Vector<crate::gapi::GRunArg>> {
+		fn apply(&mut self, callback: &impl crate::gapi::Detail_ExtractArgsCallbackTraitConst, mut args: crate::gapi::GCompileArgs) -> Result<crate::gapi::GRunArgs> {
 			return_send!(via ocvrs_return);
 			unsafe { sys::cv_GComputation_apply_const_ExtractArgsCallbackR_GCompileArgsRR(self.as_raw_mut_GComputation(), callback.as_raw_Detail_ExtractArgsCallback(), args.as_raw_mut_VectorOfGCompileArg(), ocvrs_return.as_mut_ptr()) };
 			return_receive!(unsafe ocvrs_return => ret);
 			let ret = ret.into_result()?;
-			let ret = unsafe { core::Vector::<crate::gapi::GRunArg>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::gapi::GRunArgs::opencv_from_extern(ret) };
 			Ok(ret)
 		}
 
@@ -6901,12 +6901,12 @@ pub mod gapi {
 		/// This alternative version of [GComputationTrait::apply] function uses the following default values for its arguments:
 		/// * args: {}
 		#[inline]
-		fn apply_def(&mut self, callback: &impl crate::gapi::Detail_ExtractArgsCallbackTraitConst) -> Result<core::Vector<crate::gapi::GRunArg>> {
+		fn apply_def(&mut self, callback: &impl crate::gapi::Detail_ExtractArgsCallbackTraitConst) -> Result<crate::gapi::GRunArgs> {
 			return_send!(via ocvrs_return);
 			unsafe { sys::cv_GComputation_apply_const_ExtractArgsCallbackR(self.as_raw_mut_GComputation(), callback.as_raw_Detail_ExtractArgsCallback(), ocvrs_return.as_mut_ptr()) };
 			return_receive!(unsafe ocvrs_return => ret);
 			let ret = ret.into_result()?;
-			let ret = unsafe { core::Vector::<crate::gapi::GRunArg>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::gapi::GRunArgs::opencv_from_extern(ret) };
 			Ok(ret)
 		}
 
@@ -7763,23 +7763,23 @@ pub mod gapi {
 		}
 
 		#[inline]
-		fn out_shapes(&self) -> core::Vector<crate::gapi::GShape> {
+		fn out_shapes(&self) -> crate::gapi::GShapes {
 			let ret = unsafe { sys::cv_GKernel_propOutShapes_const(self.as_raw_GKernel()) };
-			let ret = unsafe { core::Vector::<crate::gapi::GShape>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::gapi::GShapes::opencv_from_extern(ret) };
 			ret
 		}
 
 		#[inline]
-		fn in_kinds(&self) -> core::Vector<crate::gapi::Detail_OpaqueKind> {
+		fn in_kinds(&self) -> crate::gapi::GKinds {
 			let ret = unsafe { sys::cv_GKernel_propInKinds_const(self.as_raw_GKernel()) };
-			let ret = unsafe { core::Vector::<crate::gapi::Detail_OpaqueKind>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::gapi::GKinds::opencv_from_extern(ret) };
 			ret
 		}
 
 		#[inline]
-		fn out_kinds(&self) -> core::Vector<crate::gapi::Detail_OpaqueKind> {
+		fn out_kinds(&self) -> crate::gapi::GKinds {
 			let ret = unsafe { sys::cv_GKernel_propOutKinds_const(self.as_raw_GKernel()) };
-			let ret = unsafe { core::Vector::<crate::gapi::Detail_OpaqueKind>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::gapi::GKinds::opencv_from_extern(ret) };
 			ret
 		}
 
@@ -9952,12 +9952,12 @@ pub mod gapi {
 		}
 
 		#[inline]
-		fn steps(&self) -> Result<core::Vector<size_t>> {
+		fn steps(&self) -> Result<crate::gapi::RMat_View_stepsT> {
 			return_send!(via ocvrs_return);
 			unsafe { sys::cv_RMat_View_steps_const(self.as_raw_RMat_View(), ocvrs_return.as_mut_ptr()) };
 			return_receive!(unsafe ocvrs_return => ret);
 			let ret = ret.into_result()?;
-			let ret = unsafe { core::Vector::<size_t>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::gapi::RMat_View_stepsT::opencv_from_extern(ret) };
 			Ok(ret)
 		}
 
@@ -10041,12 +10041,12 @@ pub mod gapi {
 		fn as_raw_Detail_ExtractArgsCallback(&self) -> *const c_void;
 
 		#[inline]
-		fn apply(&self, info: &crate::gapi::GTypesInfo) -> Result<core::Vector<crate::gapi::GRunArg>> {
+		fn apply(&self, info: &crate::gapi::GTypesInfo) -> Result<crate::gapi::GRunArgs> {
 			return_send!(via ocvrs_return);
 			unsafe { sys::cv_detail_ExtractArgsCallback_operator___const_const_GTypesInfoR(self.as_raw_Detail_ExtractArgsCallback(), info.as_raw_VectorOfGTypeInfo(), ocvrs_return.as_mut_ptr()) };
 			return_receive!(unsafe ocvrs_return => ret);
 			let ret = ret.into_result()?;
-			let ret = unsafe { core::Vector::<crate::gapi::GRunArg>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::gapi::GRunArgs::opencv_from_extern(ret) };
 			Ok(ret)
 		}
 

docs/line_descriptor.rs

@@ -118,10 +118,10 @@ pub mod line_descriptor {
 
 	opencv_type_enum! { crate::line_descriptor::DrawLinesMatchesFlags }
 
-	pub type uint16 = u16;
-	pub type uint32 = u32;
-	pub type uint64 = u64;
-	pub type uint8 = u8;
+	pub type UINT16 = u16;
+	pub type UINT32 = u32;
+	pub type UINT64 = u64;
+	pub type UINT8 = u8;
 	/// Draws keylines.
 	/// 
 	/// ## Parameters

docs/surface_matching.rs

@@ -360,7 +360,7 @@ pub mod surface_matching {
 
 	pub const ICP_ICP_SAMPLING_TYPE_GELFAND: i32 = 1;
 	pub const ICP_ICP_SAMPLING_TYPE_UNIFORM: i32 = 0;
-	pub type key_type = u32;
+	pub type KeyType = u32;
 	pub type Pose3DPtr = core::Ptr<crate::surface_matching::Pose3D>;
 	pub type PoseCluster3DPtr = core::Ptr<crate::surface_matching::PoseCluster3D>;
 	/// Constant methods for [crate::surface_matching::ICP]
@@ -907,12 +907,12 @@ pub mod surface_matching {
 		}
 
 		#[inline]
-		fn clone(&mut self) -> Result<core::Ptr<crate::surface_matching::Pose3D>> {
+		fn clone(&mut self) -> Result<crate::surface_matching::Pose3DPtr> {
 			return_send!(via ocvrs_return);
 			unsafe { sys::cv_ppf_match_3d_Pose3D_clone(self.as_raw_mut_Pose3D(), ocvrs_return.as_mut_ptr()) };
 			return_receive!(unsafe ocvrs_return => ret);
 			let ret = ret.into_result()?;
-			let ret = unsafe { core::Ptr::<crate::surface_matching::Pose3D>::opencv_from_extern(ret) };
+			let ret = unsafe { crate::surface_matching::Pose3DPtr::opencv_from_extern(ret) };
 			Ok(ret)
 		}