NCL Home > Documentation > Functions > String manipulation

str_match_ic

Returns a list of strings that contain the given substring (case insensitive).

Available in version 6.0.0 and later.

Prototype

	function str_match_ic (
		string_array   : string,  
		sub_string [1] : string   
	)

	return_val [*] :  string

Arguments

string_array

A string array of any dimensionality.

sub_string

The substring to be matched.

Return value

Note that the return value will always be a one-dimensional array, regardless of the dimensionality of the input array. See the examples below.

Description

This function returns an array of strings with every occurrence of sub_string matched in string_array.

If there is no sub_string matched in string_array, the default string missing value ("missing") will be returned.

Note that str_match_ic is case INSENSITIVE. Use str_match if you need case sensitivity.

Examples

Example 1

 s = (/"Linux","LINUX","linux"/)

 dq = str_get_dq()

 print("str_match(s," + dq + "linux" + dq + ") = " + str_match(s,"linux"))

;print out:
;(0)     str_match(s,"linux") = linux

 print("str_match_ic(s," + dq + "linux" + dq + ") = " + str_match_ic(s,"linux"))

;print out:
;(0)     str_match_ic(s,"linux") = Linux
;(1)     str_match_ic(s,"linux") = LINUX
;(2)     str_match_ic(s,"linux") = linux

Example 2

Create a 3 x 10 string array with dummy year and month values. str_match always returns a 1D array regardless of the input array dimensionality:

;---Create dummy input array
  months       = (/"Jan","Feb","Mar","Apr","May","Jun","Jul","Aug","Sep","Oct","Nov","Dec"/)
  array2d      = new((/3,10/),string)
  array2d(0,:) = months(0:9) + " 1999"
  array2d(1,:) = months(2:11) + " 2000"
  array2d(2,:) = "Jan 20" + sprinti("%02i",ispan(1,10,1))

;---Print dummy input array
  slist = [/array2d(0,:),array2d(1,:),array2d(2,:)/]
  print_table([/"================================"/],"%s")
  print_table([/"            array2d"/],"%s")
  print_table([/"================================"/],"%s")
  print_table(slist,"  %s   %s   %s")
  print_table([/"================================"/],"%s")

;---Match all strings that contain the letters "O" or "U"
  O_strs  = str_match_ic(array2d,"O")
  u_strs  = str_match_ic(array2d,"u")

;---Print results of various string matching statements
  print("O_strs = " + str_join(O_strs,","))
  print("u_strs = " + str_join(u_strs,","))

Output: