Skip to content

Commit df29b6f

Browse files
committed
fix all nursery doc links
1 parent fd3a3f2 commit df29b6f

File tree

3 files changed

+11
-67
lines changed

3 files changed

+11
-67
lines changed

coresimd/ppsv/api/mod.rs

Lines changed: 2 additions & 54 deletions
Original file line numberDiff line numberDiff line change
@@ -1,65 +1,13 @@
11
//! This module defines the API of portable vector types.
2-
//!
3-
//! # API
4-
//!
5-
//! ## Traits
6-
//!
7-
//! All portable vector types implement the following traits:
8-
//!
9-
//! * [x] `Copy`,
10-
//! * [x] `Clone`,
11-
//! * [x] `Debug`,
12-
//! * [x] `Default`
13-
//! * [x] `PartialEq`
14-
//! * [x] `PartialOrd` (TODO: tests)
15-
//!
16-
//! Non-floating-point vector types also implement:
17-
//!
18-
//! * [x] `Hash`,
19-
//! * [x] `Eq`, and
20-
//! * [x] `Ord`.
21-
//!
22-
//! Integer vector types also implement:
23-
//!
24-
//! * [x] `fmt::LowerHex`.
25-
//!
26-
//! ## Conversions
27-
//!
28-
//! * [x]: `FromBits/IntoBits`: bitwise lossless transmutes between vectors of
29-
//! the same size (i.e., same `mem::size_of`).
30-
//! * [x]: `From/Into`: casts between vectors with the same number of lanes
31-
//! (potentially lossy).
32-
//!
33-
//! ## Inherent methods
34-
//!
35-
//! * [x] minimal API: implemented by all vector types except for boolean
36-
//! vectors.
37-
//! * [x] minimal boolean vector API: implemented by boolean vectors.
38-
//! * [x] load/store API: aligned and unaligned memory loads and
39-
//! stores - implemented by all vectors.
40-
//! * [x] comparison API: vector lane-wise comparison producing
41-
//! boolean vectors - implemented by all vectors.
42-
//! * [x] arithmetic operations: implemented by all non-boolean vectors.
43-
//! * [x] `std::ops::Neg`: implemented by signed-integer and floating-point
44-
//! vectors.
45-
//! * [x] bitwise operations: implemented by integer and boolean
46-
//! vectors.
47-
//! * [x] shift operations: implemented by integer vectors.
48-
//! * [x] arithmetic reductions: implemented by integer and floating-point
49-
//! vectors.
50-
//! * [x] bitwise reductions: implemented by integer and boolean
51-
//! vectors.
52-
//! * [x] boolean reductions: implemented by boolean vectors.
53-
//! * [ ] portable shuffles: `shufflevector`.
54-
//! * [ ] portable `gather`/`scatter`:
552
#![allow(unused)]
563

574
/// Adds the vector type `$id`, with elements of types `$elem_tys`.
585
macro_rules! define_ty {
596
($id:ident, $($elem_tys:ident),+ | $(#[$doc:meta])*) => {
607
$(#[$doc])*
618
#[repr(simd)]
62-
#[derive(Copy, Clone, Debug, /*FIXME:*/ PartialOrd)]
9+
#[derive(Copy, Clone, Debug,
10+
/*FIXME: manually implement and add tests*/ PartialOrd)]
6311
#[allow(non_camel_case_types)]
6412
pub struct $id($($elem_tys),*);
6513
}

crates/stdsimd/src/lib.rs

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,7 @@
11
//! SIMD and vendor intrinsics support library.
22
//!
33
//! This crate defines the vendor intrinsics and types primarily used for SIMD
4-
//! in Rust. The crate here will soon be available in the standard library, but
5-
//! for now you can also browse the documentation here, primarily in the `arch`
6-
//! submodule.
7-
//!
8-
//! [stdsimd]: https://rust-lang-nursery.github.io/stdsimd/x86_64/stdsimd/
4+
//! in Rust.
95
106
#![feature(const_fn, integer_atomics, staged_api, stdsimd)]
117
#![feature(doc_cfg, allow_internal_unstable)]

stdsimd/mod.rs

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -188,14 +188,14 @@
188188
/// * [`powerpc`]
189189
/// * [`powerpc64`]
190190
///
191-
/// [`x86`]: https://rust-lang-nursery.github.io/stdsimd/i686/stdsimd/arch/x86/index.html
192-
/// [`x86_64`]: https://rust-lang-nursery.github.io/stdsimd/x86_64/stdsimd/arch/x86_64/index.html
193-
/// [`arm`]: https://rust-lang-nursery.github.io/stdsimd/arm/stdsimd/arch/arm/index.html
194-
/// [`aarch64`]: https://rust-lang-nursery.github.io/stdsimd/aarch64/stdsimd/arch/aarch64/index.html
195-
/// [`mips`]: https://rust-lang-nursery.github.io/stdsimd/mips/stdsimd/arch/mips/index.html
196-
/// [`mips64`]: https://rust-lang-nursery.github.io/stdsimd/mips64/stdsimd/arch/mips64/index.html
197-
/// [`powerpc`]: https://rust-lang-nursery.github.io/stdsimd/powerpc/stdsimd/arch/powerpc/index.html
198-
/// [`powerpc64`]: https://rust-lang-nursery.github.io/stdsimd/powerpc64/stdsimd/arch/powerpc64/index.html
191+
/// [`x86`]: x86/index.html
192+
/// [`x86_64`]: x86_64/index.html
193+
/// [`arm`]: arm/index.html
194+
/// [`aarch64`]: aarch64/index.html
195+
/// [`mips`]: mips/index.html
196+
/// [`mips64`]: mips64/index.html
197+
/// [`powerpc`]: powerpc/index.html
198+
/// [`powerpc64`]: powerpc64/index.html
199199
///
200200
/// # Examples
201201
///

0 commit comments

Comments
 (0)