Struct ArraySection

pub struct ArraySection {
    pub lower_bound: Option<Expression>,
    pub length: Option<Expression>,
    pub stride: Option<Expression>,
}

Array section specification: [lower:length:stride]

OpenMP allows specifying portions of arrays using array sections:

• arr[0:N] - elements 0 through N-1
• arr[i:10:2] - 10 elements starting at i, every 2nd element
• arr[:] - all elements

Learning: Optional Fields

All three parts (lower, length, stride) are optional! This is modeled with Option<Expression>:

• Some(expr) - part is present
• None - part is omitted

Syntax Examples

OpenMP Syntax	lower	length	stride
arr[0:N]	Some(0)	Some(N)	None
arr[:]	None	None	None
arr[i:10:2]	Some(i)	Some(10)	Some(2)
arr[i]	Some(i)	None	None

Example

use roup::ir::{ArraySection, Expression, ParserConfig};

let config = ParserConfig::default();

// arr[0:N]
let section = ArraySection {
    lower_bound: Some(Expression::new("0", &config)),
    length: Some(Expression::new("N", &config)),
    stride: None,
};

Fields

lower_bound: Option<Expression>

Lower bound (starting index)

If None, starts at beginning (equivalent to 0)

length: Option<Expression>

Length (number of elements)

If None, goes to end of dimension

stride: Option<Expression>

Stride (spacing between elements)

If None, defaults to 1 (consecutive elements)

Implementations

impl ArraySection

pub fn new( lower_bound: Option<Expression>, length: Option<Expression>, stride: Option<Expression>, ) -> Self

Create a new array section with all fields

pub fn single_index(index: Expression) -> Self

Create an array section for a single index: arr[i]

Example

use roup::ir::{ArraySection, Expression, ParserConfig};

let config = ParserConfig::default();
let section = ArraySection::single_index(Expression::new("i", &config));
// Represents arr[i]

pub const fn all() -> Self

Create an array section for all elements: arr[:]

Example

use roup::ir::ArraySection;

let section = ArraySection::all();
// Represents arr[:]

pub fn is_single_index(&self) -> bool

Check if this represents a single index access

pub fn is_all(&self) -> bool

Check if this represents all elements

Trait Implementations

impl Clone for ArraySection

fn clone(&self) -> ArraySection

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ArraySection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Display for ArraySection

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Format as OpenMP array section syntax

Example

use roup::ir::{ArraySection, Expression, ParserConfig};

let config = ParserConfig::default();
let section = ArraySection::new(
    Some(Expression::new("0", &config)),
    Some(Expression::new("N", &config)),
    None,
);
assert_eq!(format!("{}", section), "0:N");

impl PartialEq for ArraySection

fn eq(&self, other: &ArraySection) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for ArraySection