Skip to content

Commit fe4ca16

Browse files
authored
Quick documentation of new CustomFiller feature.
Added a quick couple of lines to detail the CustomFiller argument.
1 parent 11310de commit fe4ca16

File tree

1 file changed

+4
-1
lines changed

1 file changed

+4
-1
lines changed

README.md

Lines changed: 4 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ arrays and use those to set the dimensions of all arrays depending on
1616
whether "small" or "big" was selected in the options. Default is "big".
1717

1818
Matrices can also be resized to certain inputted dimensions, in which case too large dimesions will be truncated and too small will be filled.
19-
The matrix filler defaults to NaN but can also be set to zero or an empty string.
19+
The matrix filler defaults to NaN but can also be set to zero or an empty string. You can now also use the CustomFiller argument to pass in any custom filler character, string, or number to the function.
2020
One output matrix is given for every input matrix.
2121
You can even mix inputs of double arrays and cell arrays and each array will be passed back in the same form it entered.
2222
See arguments notes below.
@@ -37,6 +37,9 @@ samesize(array1,array2,array3,array4,...)
3737

3838
* Filler: Sets whether to fill extra rows and columns with NaN, zero, or an empty string (only for cell arrays). Must be "NaN", "nan", "zero", "0", "String", or "string". Defaults to "NaN".
3939

40+
* CustomFiller: Send a custom filler character, string, integer, float, or double to be used to fill extra rows and columns. Input must be a (1,1) scalar of one of the previous classes. (i.e. you can't pass an array into this, just a single value, character, or word.) This argument is evaluated before (and will overwrite) the Filler argument.
41+
42+
4043
### Outputs:
4144

4245
varargout: Ouputs one array for each array in the input. They can be accessed in the order they were entered. You do not necessarily have to take every output that is generated.

0 commit comments

Comments
 (0)