Array reference More...

Inherits Variable.

Public Types
using	Iterator = class ArrayIterator
	Type alias.

Public Member Functions
	Array (Perl &perl, AV *av, bool increase_refcount)
	Constructor. More...

Array elements
Scalar	get (const SSize_t index) const
	Fetch element by index. More...

Scalar	getFirst () const
	Get first element. More...

Scalar	getLast () const
	Get last element. More...

Array &	replace (const SSize_t index, const Scalar &scalar)
	Replace element. More...

Array &	push (const Scalar &scalar)
	Add element to end. More...

Array &	push (const Array &array)
	Add other array to end. More...

Array &	push (const std::vector< Scalar > &scalars)

Array &	push (const std::list< Scalar > &scalars)

Array &	unshift (const Scalar &scalar)
	Add element to begin. More...

Array &	unshift (const Array &array)
	Add other array to begin. More...

Array &	unshift (const std::vector< Scalar > &scalars)

Array &	unshift (const std::list< Scalar > &scalars)

Scalar	pop ()
	Remove last element and return. More...

Scalar	shift ()
	Remove first element and return. More...

Array &	clear ()
	Remove all elements. More...

Misc
int	getSize () const
	Elements count. More...

bool	isEmpty () const
	Check if array is empty. More...

bool	isExists (SSize_t index) const
	Check element exists. More...

Array &	reserve (SSize_t size)
	Reserve space.

Array	makeCopy () const
	Copy each element to new array. More...

Scalar	makeRef () const
	Take reference. More...

std::string	toString () const
	Convert to C++ string.

std::vector< Scalar >	toVector () const
	Convert to C++ vector.

std::list< Scalar >	toList () const
	Convert to C++ list.

Iterator	begin () const
	Iterator to first element.

Iterator	end () const
	Iterator to last element + 1.

Internals
AV *	getAV () const
	Get raw array.

Operators
Scalar	operator[] (const SSize_t index) const noexcept
	Unsafe version of get()

Array &	operator+= (const Scalar &scalar)
	Alias to push()

Array &	operator<< (const Scalar &scalar)
	Alias to push()

Array	operator+ (const Array &other) const
	Merge two arrays. More...

	operator bool () const
	Alias to ! isEmpty()

Public Member Functions inherited from Variable
	Variable (Perl &perl, SV *sv, bool increase_refcount)
	Constructor.

	Variable (const Variable &to_copy)
	Copy constructor. More...

	Variable (Variable &&to_move)
	Move constructor. More...

virtual	~Variable ()
	Destructor. More...

void	setReadOnly (bool state)
	Add/remove readonly flag.

bool	isReadOnly () const
	Check if SV has readonly flag.

Perl &	getPerl () const
	Get Perl instance.

SV *	getSV () const
	Get raw scalar.

SV *	detachSV ()
	Nullify object and return SV. More...

SV *	detachMortalSV ()
	Nullify object and return mortalized SV. More...

U32	getRefcount () const
	Get SV reference count.

void	increaseRefcount ()
	Increase SV reference count.

void	decreaseRefcount ()
	Decrease SV reference count.

void	dump () const
	Dump SV data to stderr.

bool	operator== (const Variable &other)
	Compare SV pointers.

bool	operator!= (const Variable &other)

Detailed Description

Array reference

Example: Array array = perl.newArray({ 1, 2, 3 }); // (my) @array = (1, 2, 3)
array.unshift(perl.newScalar(0)); // unshift @array, 0
array.push(perl.newScalar(4)); // push @array, 4
Scalar second = array.get(1).makeCopy(); // $second = $array[1]
Array copy = array.makeCopy(); // @copy = @array

Definition at line 26 of file array.hpp.

Constructor & Destructor Documentation

Array	(	Perl &	perl,
		AV *	av,
		bool	increase_refcount
	)

Constructor.

Use Perl::newArray() instead

Definition at line 9 of file array.cpp.

Member Function Documentation

Scalar get ( const SSize_t index ) const

Fetch element by index.

Perl equivalent: $scalar = $array[index]

Note: Scalar not copied, use get(index).makeCopy()

Exceptions

PerlException Bound check failure

Definition at line 16 of file array.cpp.

Scalar getFirst ( ) const

Get first element.

Perl equivalent: $scalar = $array[0]

Note: Scalar not copied, use getFirst().makeCopy()

Exceptions

PerlException Bound check failure

Definition at line 42 of file array.cpp.

Scalar getLast ( ) const

Get last element.

Perl equivalent: $scalar = $array[-1]

Note: Scalar not copied, use getLast().makeCopy()

Exceptions

PerlException Bound check failure

Definition at line 47 of file array.cpp.

Array & replace	(	const SSize_t	index,
		const Scalar &	scalar
	)

Replace element.

Perl equivalent: $array[index] = $scalar

Note: Scalar not copied, use replace(index, scalar.makeCopy())

Exceptions

PerlException Bound check failure

Definition at line 52 of file array.cpp.

Array & push ( const Scalar & scalar )

Add element to end.

Perl equivalent: push @array, $scalar

Note: Scalar not copied, use push(scalar.makeCopy())

Definition at line 75 of file array.cpp.

Array & push ( const Array & array )

Add other array to end.

Perl equivalent: push @array, @other

Note: Elements not copied, use push(array.makeCopy())

Definition at line 81 of file array.cpp.

Array & unshift ( const Scalar & scalar )

Add element to begin.

Perl equivalent: unshift @array, $scalar

Note: Scalar not copied, use unshift(scalar.makeCopy())

Definition at line 105 of file array.cpp.

Array & unshift ( const Array & array )

Add other array to begin.

Perl equivalent: unshift @array, @other

Note: Elements not copied, use unshift(array.makeCopy())

Definition at line 113 of file array.cpp.

Scalar pop ( )

Remove last element and return.

Perl equivalent: $scalar = pop @array

Note: Scalar not copied, use pop().makeCopy()

Exceptions

PerlException Bound check failure

Definition at line 146 of file array.cpp.

Scalar shift ( )

Remove first element and return.

Perl equivalent: $scalar = pop @array

Note: Scalar not copied, use shift().makeCopy()

Exceptions

PerlException Bound check failure

Definition at line 168 of file array.cpp.

Array & clear ( )

Remove all elements.

Perl equivalent: @array = ()

Definition at line 190 of file array.cpp.

int getSize ( ) const

Elements count.

Perl equivalent: scalar @array

Definition at line 198 of file array.cpp.

bool isEmpty ( ) const

Check if array is empty.

Perl equivalent: !@array

Definition at line 203 of file array.cpp.

bool isExists ( SSize_t index ) const

Check element exists.

Perl equivalent: exists $array[index]

Definition at line 208 of file array.cpp.

Array makeCopy ( ) const

Copy each element to new array.

Perl equivalent: @copy = @array

See also: Scalar::makeCopy()

Definition at line 219 of file array.cpp.

Scalar makeRef ( ) const

Take reference.

Perl equivalent: $ref = \@array

Definition at line 230 of file array.cpp.

Array operator+ ( const Array & other ) const

Merge two arrays.

Perl equivalent: @array = (@array1, @array2)

Note: Elements not copied, use array1.makeCopy() + array2.makeCopy()

Definition at line 313 of file array.cpp.

The documentation for this class was generated from the following files:

include/yobaperl/array.hpp
src/array.cpp

Public Types

Public Member Functions

Detailed Description

Constructor & Destructor Documentation

Member Function Documentation