Skip to content

Commit c53c7f2

Browse files
committed
Update docs about type of Array returned by comparison ops
1 parent b646fbb commit c53c7f2

File tree

1 file changed

+11
-0
lines changed

1 file changed

+11
-0
lines changed

src/arith/mod.rs

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -255,6 +255,17 @@ macro_rules! overloaded_binary_func {
255255
///
256256
/// An Array with results of the binary operation.
257257
///
258+
/// In the case of comparison operations such as the following, the type of output
259+
/// Array is [DType::B8](./enum.DType.html). To retrieve the results of such boolean output
260+
/// to host, an array of 8-bit wide types(eg. u8, i8) should be used since ArrayFire's internal
261+
/// implementation uses char for boolean.
262+
///
263+
/// * [gt](./fn.gt.html)
264+
/// * [lt](./fn.lt.html)
265+
/// * [ge](./fn.ge.html)
266+
/// * [le](./fn.le.html)
267+
/// * [eq](./fn.eq.html)
268+
///
258269
///# Note
259270
///
260271
/// The trait `Convertable` essentially translates to a scalar native type on rust or Array.

0 commit comments

Comments
 (0)