startsWith — Test whether text values start with specified prefixes using MATLAB-compatible broadcasting and case options.
startsWith(str, pattern) returns logical results indicating whether each text element begins with a corresponding prefix. It supports MATLAB-compatible string, char, and cellstr containers plus implicit expansion rules.
Syntax
tf = startsWith(str, pat)
tf = startsWith(str, pat, ignoreCase)
tf = startsWith(str, pat, "IgnoreCase", value)Inputs
str- Type
Any- Required
- Yes
- Description
- Text input (string/char/cell/string array).
pat- Type
Any- Required
- Yes
- Description
- Pattern text (string/char/cell/string array).
ignoreCase- Type
Any- Required
- Yes
- Default
false- Description
- Logical flag controlling case-sensitive matching.
name- Type
StringScalar- Required
- Yes
- Default
"IgnoreCase"- Description
- Option name (`"IgnoreCase"`).
value- Type
Any- Required
- Yes
- Description
- Option value for `"IgnoreCase"`.
Returns
tf- Type
LogicalArray- Description
- Logical result indicating whether each text element starts with the pattern.
Errors
RunMat:startsWith:InvalidInput- When
- Text or pattern input is not a supported text container.
- Message
startsWith: text and pattern inputs must be text values
RunMat:startsWith:InvalidOption- When
- IgnoreCase option arguments are invalid or malformed.
- Message
startsWith: invalid option arguments
RunMat:startsWith:ShapeMismatch- When
- Text and pattern inputs are not broadcast-compatible.
- Message
startsWith: input sizes are not broadcast-compatible
RunMat:startsWith:InternalError- When
- Internal logical result assembly failed.
- Message
startsWith: internal error
Behavior
Accepts text inputs as string scalars/arrays, character vectors/arrays, or cell arrays of character vectors.
Accepts patterns in the same formats; scalar inputs expand across the other argument following MATLAB broadcast rules.
Typed missing strings (displayed as <missing>) never match any pattern.
Empty patterns ("" or '') always match non-missing text elements.
Typed missing pattern elements never match and therefore return false; literal <missing> patterns are ordinary text.
Character arrays treat each row as an independent element; zero-row character arrays yield empty outputs.
MATLAB-compatible mode accepts the documented 'IgnoreCase', logicalValue name-value form. RunMat mode additionally accepts positional, numeric, textual, and resident scalar flag forms behind explicit compatibility extensions.
All eight integer classes are read exactly as RunMat-only IgnoreCase controls: zero is false and every nonzero value is true.
Returns a logical scalar when the broadcasted size is one element, otherwise returns a logical array.
Placement and effects
Matching operates on host text. The builtin has no text GPU kernel or fusion form; numeric and resident text-role inputs reject before provider access. It may throw for malformed arguments and options, but does not mutate workspace state or access files, network, randomness, or time.
An unused result is still evaluated and discarded. Ordinary host-text distribution is distinct from distributed-input support for this builtin.
Examples
Determine whether a string starts with a prefix
tf = startsWith("RunMat Accelerate", "RunMat")Expected output:
tf = logical
1Perform a case-insensitive prefix check
tf = startsWith("RunMat", "run", 'IgnoreCase', true)Expected output:
tf = logical
1Ignoring case with a positional flag
tf = startsWith("RUNMAT", "run", true)Expected output:
tf = logical
1Apply a scalar prefix to every element of a string array
labels = ["alpha" "beta" "gamma"];
tf = startsWith(labels, "a")Expected output:
tf = 1×3 logical array
1 0 0Match element-wise prefixes with implicit expansion
names = ["hydrogen"; "helium"; "lithium"];
prefixes = ["hyd"; "hel"; "lit"];
tf = startsWith(names, prefixes)Expected output:
tf = 3×1 logical array
1
1
1Test prefixes for a cell array of character vectors
C = {'Mercury', 'Venus', 'Mars'};
tf = startsWith(C, 'M')Expected output:
tf = 1×3 logical array
1 0 1Provide multiple prefixes as a column vector
tf = startsWith("saturn", ['s'; 'n'; 'x'])Expected output:
tf = 3×1 logical array
1
0
0Handle empty and missing values
texts = ["", string(missing)];
tf = startsWith(texts, "")Expected output:
tf = 1×2 logical array
1 0Using startsWith with coding agents
Open a RunMat example with live inputs, then ask the agent to explain how startsWith changes the result.
Run a small startsWith example, explain the result, then change one input and compare the output.
FAQ
What types can I pass to startsWith?⌄
Use string scalars/arrays, character vectors/arrays, or cell arrays of character vectors for both arguments. Mixed combinations are accepted, and RunMat performs MATLAB-style implicit expansion when the array sizes differ.
How do I ignore letter case?⌄
For MATLAB-compatible code, supply 'IgnoreCase', true. RunMat mode also accepts textual, numeric, positional, and resident scalar extensions; the default remains case-sensitive.
What happens with empty patterns?⌄
Empty patterns ("" or '') always match non-missing text elements. When the text element is missing (<missing>), the result is false.
Can I provide multiple prefixes at once?⌄
Yes. Provide pattern as a string array, character array, or cell array of character vectors. RunMat applies implicit expansion so that scalar inputs expand across the other argument automatically.
How are missing strings treated?⌄
Missing string scalars (displayed as <missing>) never match any pattern and produce false in the result. Use ismissing if you need to handle missing values separately.
Does startsWith run on the GPU?⌄
Text matching runs on the host and has no GPU text kernel. Numeric or resident values in text roles are rejected before provider access; supported scalar controls are handled separately.
Does startsWith preserve the input shape?⌄
Yes. The output is a logical array whose shape reflects the MATLAB-style implicit expansion result. When that shape contains exactly one element, the builtin returns a logical scalar.
Related Strings functions
Text Analytics
addDependencyDetails · addEntityDetails · addLemmaDetails · addPartOfSpeechDetails · addSentenceDetails · addTypeDetails · bagOfNgrams · bagOfWords · cosineSimilarity · doc2sequence · encode · extractFileText · extractHTMLText · fastTextWordEmbedding · findElement · getAttribute · htmlTree · ind2word · isVocabularyWord · normalizeWords · readWordEmbedding · removeLongWords · removeShortWords · removeStopWords · removeWords · stopWords · tokenDetails · tokenizedDocument · trainWordEmbedding · vaderSentimentScores · vec2word · word2ind · word2vec · wordEncoding · writeWordEmbedding
Transform
append · deblank · erase · eraseBetween · erasePunctuation · eraseURLs · extractAfter · extractBefore · extractBetween · insertAfter · insertBefore · join · lower · pad · replace · replaceBetween · reverse · split · splitlines · strcat · strip · strjoin · strjust · strrep · strsplit · strtrim · upper
Core
blanks · char · compose · convertCharsToStrings · convertContainedStringsToChars · convertStringsToChars · genvarname · int2str · isletter · isspace · isStringScalar · isstrprop · mat2str · native2unicode · newline · num2str · sprintf · sscanf · str2double · str2num · strcmp · strcmpi · string · string.empty · strings · strlength · strncmp · strncmpi · strtok · unicode2native
Pattern
digitsPattern · lettersPattern · pattern · regexpPattern · textBoundary · wildcardPattern
Source you can read
Every RunMat function's source is public. Read exactly how startsWith is executed, line by line, in Rust.
- View the source for startsWith in Rust on GitHub
- Learn how the RunMat runtime works
- Found a bug? Open an issue with a minimal reproduction.
About RunMat
RunMat is a runtime that executes MATLAB-syntax code fast on any GPU. The runtime is free for individuals, including freelancers; students and faculty at an academic institution, for teaching or research there; contributors to an open-source project, for work on that project; organizations with 250 or fewer people and US$10M or less in annual revenue; and anyone, for non-production use. See runmat.com/license.
- RunMat automatically optimizes your math for GPU execution on Apple, Nvidia, and AMD hardware. No code changes needed. Simulations that took hours now take minutes.
- Start running code in seconds. RunMat runs in the browser, on the desktop, or from the CLI. No license server, no IT ticket.