padarray {matlab}

MATLAB padarray function

Description

Pad array.

Usage

padarray(A, padsize, padval=0, direction=c("both", "pre", "post"))

Arguments

A

vector, matrix, or array to be padded

padsize

integer vector specifying both amount of padding and the dimension along which to add it

padval

scalar value specifying pad value, which defaults to 0.
Instead, it may specify the method used to determine pad values.
Valid values for the method are:

"circular"	pad with circular repetition of elements within the dimension
"replicate"	pad by repeating border elements of array
"symmetric"	pad array with mirror reflections of itself

direction

character string specifying direction to apply padding.
Valid values are:

"both"	pad before first element and after last array element along each dimension
"pre"	pad after last array element along each dimension
"post"	pad before first array element along each dimension

Details

This is an S4 generic function.

Value

Return value is the same type as argument A with requested padding.

Author(s)

P. Roebuck [e-mail]

Examples

padarray(1:4, c(0, 2))				# 0 0 [1 2 3 4] 0 0
padarray(1:4, c(0, 2), -1)			# -1 -1 [1 2 3 4] -1 -1
padarray(1:4, c(0, 2), -1, "post")		# [1 2 3 4] -1 -1
padarray(1:4, c(0, 3), "symmetric", "pre")	# 3 2 1 [1 2 3 4]
padarray(letters[1:5], c(0, 3), "replicate")	# a a a [a b c d e] e e e
padarray(letters[1:5], c(0, 3), "circular", "post")	# [a b c d e] a b c