Skip to content

fix all nursery doc links #506

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Jun 26, 2018
Merged

fix all nursery doc links #506

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
56 changes: 2 additions & 54 deletions coresimd/ppsv/api/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,65 +1,13 @@
//! This module defines the API of portable vector types.
//!
//! # API
//!
//! ## Traits
//!
//! All portable vector types implement the following traits:
//!
//! * [x] `Copy`,
//! * [x] `Clone`,
//! * [x] `Debug`,
//! * [x] `Default`
//! * [x] `PartialEq`
//! * [x] `PartialOrd` (TODO: tests)
//!
//! Non-floating-point vector types also implement:
//!
//! * [x] `Hash`,
//! * [x] `Eq`, and
//! * [x] `Ord`.
//!
//! Integer vector types also implement:
//!
//! * [x] `fmt::LowerHex`.
//!
//! ## Conversions
//!
//! * [x]: `FromBits/IntoBits`: bitwise lossless transmutes between vectors of
//! the same size (i.e., same `mem::size_of`).
//! * [x]: `From/Into`: casts between vectors with the same number of lanes
//! (potentially lossy).
//!
//! ## Inherent methods
//!
//! * [x] minimal API: implemented by all vector types except for boolean
//! vectors.
//! * [x] minimal boolean vector API: implemented by boolean vectors.
//! * [x] load/store API: aligned and unaligned memory loads and
//! stores - implemented by all vectors.
//! * [x] comparison API: vector lane-wise comparison producing
//! boolean vectors - implemented by all vectors.
//! * [x] arithmetic operations: implemented by all non-boolean vectors.
//! * [x] `std::ops::Neg`: implemented by signed-integer and floating-point
//! vectors.
//! * [x] bitwise operations: implemented by integer and boolean
//! vectors.
//! * [x] shift operations: implemented by integer vectors.
//! * [x] arithmetic reductions: implemented by integer and floating-point
//! vectors.
//! * [x] bitwise reductions: implemented by integer and boolean
//! vectors.
//! * [x] boolean reductions: implemented by boolean vectors.
//! * [ ] portable shuffles: `shufflevector`.
//! * [ ] portable `gather`/`scatter`:
#![allow(unused)]

/// Adds the vector type `$id`, with elements of types `$elem_tys`.
macro_rules! define_ty {
($id:ident, $($elem_tys:ident),+ | $(#[$doc:meta])*) => {
$(#[$doc])*
#[repr(simd)]
#[derive(Copy, Clone, Debug, /*FIXME:*/ PartialOrd)]
#[derive(Copy, Clone, Debug,
/*FIXME: manually implement and add tests*/ PartialOrd)]
#[allow(non_camel_case_types)]
pub struct $id($($elem_tys),*);
}
Expand Down
6 changes: 1 addition & 5 deletions crates/stdsimd/src/lib.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,11 +1,7 @@
//! SIMD and vendor intrinsics support library.
//!
//! This crate defines the vendor intrinsics and types primarily used for SIMD
//! in Rust. The crate here will soon be available in the standard library, but
//! for now you can also browse the documentation here, primarily in the `arch`
//! submodule.
//!
//! [stdsimd]: https://rust-lang-nursery.github.io/stdsimd/x86_64/stdsimd/
//! in Rust.

#![feature(const_fn, integer_atomics, staged_api, stdsimd)]
#![feature(doc_cfg, allow_internal_unstable)]
Expand Down
16 changes: 8 additions & 8 deletions stdsimd/mod.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -188,14 +188,14 @@
/// * [`powerpc`]
/// * [`powerpc64`]
///
/// [`x86`]: https://rust-lang-nursery.github.io/stdsimd/i686/stdsimd/arch/x86/index.html
/// [`x86_64`]: https://rust-lang-nursery.github.io/stdsimd/x86_64/stdsimd/arch/x86_64/index.html
/// [`arm`]: https://rust-lang-nursery.github.io/stdsimd/arm/stdsimd/arch/arm/index.html
/// [`aarch64`]: https://rust-lang-nursery.github.io/stdsimd/aarch64/stdsimd/arch/aarch64/index.html
/// [`mips`]: https://rust-lang-nursery.github.io/stdsimd/mips/stdsimd/arch/mips/index.html
/// [`mips64`]: https://rust-lang-nursery.github.io/stdsimd/mips64/stdsimd/arch/mips64/index.html
/// [`powerpc`]: https://rust-lang-nursery.github.io/stdsimd/powerpc/stdsimd/arch/powerpc/index.html
/// [`powerpc64`]: https://rust-lang-nursery.github.io/stdsimd/powerpc64/stdsimd/arch/powerpc64/index.html
/// [`x86`]: x86/index.html
/// [`x86_64`]: x86_64/index.html
/// [`arm`]: arm/index.html
/// [`aarch64`]: aarch64/index.html
/// [`mips`]: mips/index.html
/// [`mips64`]: mips64/index.html
/// [`powerpc`]: powerpc/index.html
/// [`powerpc64`]: powerpc64/index.html
///
/// # Examples
///
Expand Down