From 73ec484ac3b18b3c05f8acb612d408dcf249df4b Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Andreas=20Kl=C3=B6ckner?= <inform@tiker.net> Date: Fri, 26 Jan 2018 15:06:51 -0500 Subject: [PATCH] Update docs for ArrayBase.alignment --- loopy/kernel/array.py | 12 +++++++++--- 1 file changed, 9 insertions(+), 3 deletions(-) diff --git a/loopy/kernel/array.py b/loopy/kernel/array.py index f86c3f9a3..b672f0227 100644 --- a/loopy/kernel/array.py +++ b/loopy/kernel/array.py @@ -610,11 +610,17 @@ class ArrayBase(ImmutableRecord): .. attribute:: alignment - Memory alignment of the array in bytes. - Default to *None*. If an integer N is given, the array would be declared + Memory alignment of the array in bytes. For temporary arrays, + this ensures they are allocated with this alignment. For arguments, + this entails a promise that the incoming array obeys this alignment + restriction. + + Defaults to *None*. + + If an integer N is given, the array would be declared with ``__attribute__((aligned(N)))`` in code generation for :class:`loopy.CTarget`. - + .. versionadded:: 2018.1 .. automethod:: __init__ -- GitLab