Doc update

2016-02-05 09:55:57 -06:00
parent 39c5f0f610
commit a06e0d9050
3 changed files with 110 additions and 56 deletions
@@ -1,53 +1,54 @@
-# HIP Kernel Language
+<!-- START doctoc generated TOC please keep comment here to allow auto update -->
+<!-- DON'T EDIT THIS SECTION, INSTEAD RE-RUN doctoc TO UPDATE -->
+**Table of Contents**  *generated with [DocToc](https://github.com/thlorenz/doctoc)*
+
+- [Introduction](#introduction)
+- [Function-Type Qualifiers](#function-type-qualifiers)
+  - [`__device__`](#__device__)
+  - [`__global__`](#__global__)
+  - [`__host__`](#__host__)
+- [Calling `__global__` Functions](#calling-__global__-functions)
+- [Kernel-Launch Example](#kernel-launch-example)
+- [Variable-Type Qualifiers](#variable-type-qualifiers)
+  - [`__constant__`](#__constant__)
+  - [`__shared__`](#__shared__)
+  - [`__managed__`](#__managed__)
+  - [`__restrict__`](#__restrict__)
+- [Built-In Variables](#built-in-variables)
+  - [Coordinate Built-Ins](#coordinate-built-ins)
+  - [warpSize](#warpsize)
+- [Vector Types](#vector-types)
+  - [Short Vector Types](#short-vector-types)
+  - [dim3](#dim3)
+- [Memory-Fence Instructions](#memory-fence-instructions)
+- [Synchronization Functions](#synchronization-functions)
+- [Math Functions](#math-functions)
+  - [Single Precision Mathematical Functions](#single-precision-mathematical-functions)
+  - [Double Precision Mathematical Functions](#double-precision-mathematical-functions)
+  - [Integer Intrinsics](#integer-intrinsics)
+- [Texture Functions](#texture-functions)
+- [Surface Functions](#surface-functions)
+- [Timer Functions](#timer-functions)
+- [Atomic Functions](#atomic-functions)
+  - [Caveats and Features Under-Development:](#caveats-and-features-under-development)
+- [Warp Cross-Lane Functions](#warp-cross-lane-functions)
+  - [Warp Vote and Ballot Functions](#warp-vote-and-ballot-functions)
+  - [Warp Shuffle Functions](#warp-shuffle-functions)
+- [Profiler Counter Function](#profiler-counter-function)
+- [Assert](#assert)
+- [Printf](#printf)
+- [Device-Side Dynamic Global Memory Allocation](#device-side-dynamic-global-memory-allocation)
+- [`__launch_bounds__`](#__launch_bounds__)
+- [Register Keyword](#register-keyword)
+- [Pragma Unroll](#pragma-unroll)
+- [In-Line Assembly](#in-line-assembly)
+- [C++ Support](#c-support)
+
+<!-- END doctoc generated TOC please keep comment here to allow auto update -->


-###Table of Contents
-=================
-
-  * [HIP Kernel Language](#hip-kernel-language" aria-hidden="true"><span aria-hidden="true)
-    * [Table of Contents](#table-of-contents" aria-hidden="true"><span aria-hidden="true)
-    * [Function-Type Qualifiers](#function-type-qualifiers" aria-hidden="true"><span aria-hidden="true)
-      * [__device__ ](#__device__" aria-hidden="true"><span aria-hidden="true)
-      * [__global__ ](#__global__" aria-hidden="true"><span aria-hidden="true)
-      * [__host__ ](#__host__" aria-hidden="true"><span aria-hidden="true)
-    * [Calling __global__ Functions](#calling-__global__-functions" aria-hidden="true"><span aria-hidden="true)
-    * [Kernel-Launch Example](#kernel-launch-example" aria-hidden="true"><span aria-hidden="true)
-    * [Variable-Type Qualifiers](#variable-type-qualifiers" aria-hidden="true"><span aria-hidden="true)
-      * [__constant__ ](#__constant__" aria-hidden="true"><span aria-hidden="true)
-      * [__shared__ ](#__shared__" aria-hidden="true"><span aria-hidden="true)
-      * [__managed__ ](#__managed__" aria-hidden="true"><span aria-hidden="true)
-      * [__restrict__ ](#__restrict__" aria-hidden="true"><span aria-hidden="true)
-    * [Built-In Variables](#built-in-variables" aria-hidden="true"><span aria-hidden="true)
-      * [Coordinate Built-Ins](#coordinate-built-ins" aria-hidden="true"><span aria-hidden="true)
-      * [warpSize](#warpsize" aria-hidden="true"><span aria-hidden="true)
-    * [Vector Types](#vector-types" aria-hidden="true"><span aria-hidden="true)
-      * [Short Vector Types](#short-vector-types" aria-hidden="true"><span aria-hidden="true)
-      * [dim3](#dim3" aria-hidden="true"><span aria-hidden="true)
-    * [Memory-Fence Instructions](#memory-fence-instructions" aria-hidden="true"><span aria-hidden="true)
-    * [Synchronization Functions](#synchronization-functions" aria-hidden="true"><span aria-hidden="true)
-    * [Math Functions](#math-functions" aria-hidden="true"><span aria-hidden="true)
-      * [Single Precision Mathematical Functions](#single-precision-mathematical-functions" aria-hidden="true"><span aria-hidden="true)
-      * [Double Precision Mathematical Functions](#double-precision-mathematical-functions" aria-hidden="true"><span aria-hidden="true)
-      * [Integer Intrinsics](#integer-intrinsics" aria-hidden="true"><span aria-hidden="true)
-    * [Texture Functions](#texture-functions" aria-hidden="true"><span aria-hidden="true)
-    * [Surface Functions](#surface-functions" aria-hidden="true"><span aria-hidden="true)
-    * [Timer Functions](#timer-functions" aria-hidden="true"><span aria-hidden="true)
-    * [Atomic Functions](#atomic-functions" aria-hidden="true"><span aria-hidden="true)
-      * [Caveats and Features Under-Development:](#caveats-and-features-under-development" aria-hidden="true"><span aria-hidden="true)
-    * [Warp Cross-Lane Functions](#warp-cross-lane-functions" aria-hidden="true"><span aria-hidden="true)
-      * [Warp Vote and Ballot Functions](#warp-vote-and-ballot-functions" aria-hidden="true"><span aria-hidden="true)
-      * [Warp Shuffle Functions](#warp-shuffle-functions" aria-hidden="true"><span aria-hidden="true)
-    * [Profiler Counter Function](#profiler-counter-function" aria-hidden="true"><span aria-hidden="true)
-    * [Assert](#assert" aria-hidden="true"><span aria-hidden="true)
-    * [Printf](#printf" aria-hidden="true"><span aria-hidden="true)
-    * [Device-Side Dynamic Global Memory Allocation](#device-side-dynamic-global-memory-allocation" aria-hidden="true"><span aria-hidden="true)
-    * [__launch_bounds__ ](#__launch_bounds__" aria-hidden="true"><span aria-hidden="true)
-    * [Register Keyword](#register-keyword" aria-hidden="true"><span aria-hidden="true)
-    * [Pragma Unroll](#pragma-unroll" aria-hidden="true"><span aria-hidden="true)
-    * [In-Line Assembly](#in-line-assembly" aria-hidden="true"><span aria-hidden="true)
-    * [C   Support](#c-support" aria-hidden="true"><span aria-hidden="true)
-

+## Introduction

 HIP provides a C++ syntax that is suitable for compiling most code that commonly appears in compute kernels, including classes, namespaces, operator overloading, templates and more. Additionally, it defines other language features designed specifically to target accelerators, such as the following:
 - A kernel-launch syntax that uses standard C++, resembles a function call and is portable to all HIP targets