Skip to content
This repository has been archived by the owner on Feb 18, 2024. It is now read-only.

Commit

Permalink
update docs
Browse files Browse the repository at this point in the history
  • Loading branch information
yjhmelody committed Oct 8, 2021
1 parent 6a01024 commit 6efa460
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 9 deletions.
2 changes: 1 addition & 1 deletion src/compute/arithmetics/basic/add.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ where
binary(lhs, rhs, lhs.data_type().clone(), |a, b| a + b)
}

/// Wrapping addition of two `PrimitiveArray`s.
/// Wrapping addition of two [`PrimitiveArray`]s.
/// It wraps around at the boundary of the type if the result overflows.
///
/// # Examples
Expand Down
7 changes: 3 additions & 4 deletions src/compute/arithmetics/basic/mul.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ where
binary(lhs, rhs, lhs.data_type().clone(), |a, b| a * b)
}

/// Wrapping multiplication of two primitive arrays.
/// It do nothing if the result overflows.
/// Wrapping multiplication of two [`PrimitiveArray`]s.
/// It wraps around at the boundary of the type if the result overflows.
///
/// # Examples
/// ```
Expand Down Expand Up @@ -168,7 +168,6 @@ where
}
}

// Implementation of ArrayWrappingMul trait for PrimitiveArrays
impl<T> ArrayWrappingMul<PrimitiveArray<T>> for PrimitiveArray<T>
where
T: NativeType + WrappingMul<Output = T> + NotI128,
Expand Down Expand Up @@ -236,7 +235,7 @@ where
unary(lhs, |a| a * rhs, lhs.data_type().clone())
}

/// Wrapping multiplication of a scalar T to a primitive array of type T.
/// Wrapping multiplication of a scalar T to a [`PrimitiveArray`] of type T.
/// It do nothing if the result overflows.
///
/// # Examples
Expand Down
7 changes: 3 additions & 4 deletions src/compute/arithmetics/basic/sub.rs
Original file line number Diff line number Diff line change
Expand Up @@ -43,8 +43,8 @@ where
binary(lhs, rhs, lhs.data_type().clone(), |a, b| a - b)
}

/// Wrapping subtraction of two primitive arrays.
/// It do nothing if the result overflows.
/// Wrapping subtraction of two [`PrimitiveArray`]s.
/// It wraps around at the boundary of the type if the result overflows.
///
/// # Examples
/// ```
Expand Down Expand Up @@ -167,7 +167,6 @@ where
}
}

// Implementation of ArrayWrappingSub trait for PrimitiveArrays
impl<T> ArrayWrappingSub<PrimitiveArray<T>> for PrimitiveArray<T>
where
T: NativeType + WrappingSub<Output = T> + NotI128,
Expand Down Expand Up @@ -236,7 +235,7 @@ where
unary(lhs, |a| a - rhs, lhs.data_type().clone())
}

/// Wrapping subtraction of a scalar T to a primitive array of type T.
/// Wrapping subtraction of a scalar T to a [`PrimitiveArray`] of type T.
/// It do nothing if the result overflows.
///
/// # Examples
Expand Down

0 comments on commit 6efa460

Please sign in to comment.