containsWords

Check if word is member of documents

Since R2022b

Syntax

tf = containsWords(documents,words)

tf = containsWords(documents,words,IgnoreCase=flag)

Description

tf = containsWords(documents,words) returns 1 where any token of documents matches words and returns 0 otherwise.

tf = containsWords(documents,words,IgnoreCase=flag) also specifies whether to ignore letter case when checking words.

Examples

Check if Word Is Member of Document

Create an array of tokenized documents.

documents = tokenizedDocument([
    "an example of a short sentence" 
    "a second short sentence"]);

Check for documents containing the word "second".

tf = containsWords(documents,"second")

tf = 2×1 logical array

   0
   1

Input Arguments

documents — Input documents

tokenizedDocument array

Input documents, specified as a tokenizedDocument array.

words — Words to check

string array | character vector | cell array of character vectors | pattern array

Words to check, specified as one of these values:

• String array

• Character vector

• Cell array of character vectors

• pattern array

If words contains multiple words, then the function returns 1 where any of the words appear in the corresponding document.

flag — Option to ignore case

0 (false) (default) | 1 (true)

Option to ignore case, specified as one of these values:

• 0 (false) – Treat candidate matches that differ only by letter case as nonmatching.

• 1 (true) – Treat candidate matches that differ only by letter case as matching.

Data Types: single | double | int8 | int16 | int32 | int64 | uint8 | uint16 | uint32 | uint64 | logical

Version History

Introduced in R2022b