INDEX: index, scan, nearest, verify for substring in string, scalar in array, and scalar in file matrix column (f)

• search substring in string

  operations:
  • result = INDEX(string, substring [, options [, length]] )
  • values of options are additive, e.g. "case sensitive" and "word" = 1+2 =3
  • length returns the character count, useful for regular expression searches

  find options	string search type	example	result
  0	case insensitive, default	INDEX("aA bB cC", "A")	1
  1	case sensitive	INDEX("aA bB cC", "A", 1)	2
  2	word	INDEX("aA bB cC", "A", 2)	0
  4	backward search	INDEX("aA bB cC", "a", 4)	2
  8	scan (1st character of string that is also in substring)	INDEX("aA bB cC", "cbx", 8)	4
  16	include trailing blanks	INDEX("a a a", "a ", 16)	3
  32	best match	INDEX("aA bB cCe"," bC",32)	3
  64	verify (1st character of string that is not in substring)	INDEX("aA bB cCe"," ab",64)	7
  128	regular expression	INDEX(string, "gr.y", 128)	gray or grey
  256	count occurences	INDEX("aA bB cC", "c", 256)	2

  regex	option +128 in INDEX and EDIT	check in MatrixExplorer and script search
  .	any single character	"gr.y" matches gray or grey
  ?	preceding token is optional	"colo?ur" matches color or colour
  *	match preceding token zero or more times	"fo*l" matches fly, fold, fool
  +	match preceding token once or more	"fo+l" matches fold, fool
  ^	Beginning of line	"^a" matches lines beginning with a
  $	End of line	"z$" matches lines ending with z
  [	Open set of single characters to be matched
  	[aeio]n	matches an, end, in, on
  	[^xyz]	do not match (x or y or z)
  	[A-Z]	a single character in the range A and Z (inclusive)
  	[0-9A-F]	a single hex digit (case sensitive with Option=1)
  ]	Close set of single characters to be matched
  |	few|all|none	matches "few" or "all" or "none"
  \	escape	"\^" matches "^" instead of "Beginning of line"
  	\a	alfabetic digit
  	\d	numeric digit
  	\s	space, tab, carriage return, or line feed
  	\w	alfanumeric digit
  	\z	hexadecimal digit

  • options are additive, e.g. option=1+4+8 scans case sensitive backward
  • ⇒ EDIT facilitates many string manipulations

• string in file matrix search

  operations:
  • result = INDEX( matrix_file_name(start_row, column), substring [, options] )
  1. format=...)
  2. result is the absolute row number (independend of the current value of start_row) of the 1st matrix element that contains substring
  3. available options are as above

• scalar in vector search

  operations:
  • result = INDEX(vector, scalar [, options] )

  • comparison tolerance

    for all numeric comparisons in HicEst is 1E-13
  • example vector: vec5 = (3, 1, -1, 1, 5)

  option	numeric scalar search type	example	result
  0	forward, default. Finds are for ABS(delta) ≤ 1E13	INDEX(vec5, 1)	2
  4	backward	INDEX(vec5, 1.00001, 4)	0
  32	best match	INDEX(vec5, 1.00001, 4+32)	4

• numeric file matrix search

  column operations:
  1. open file for matrix operations
  2. • result = INDEX( file(start_row, column), search_value [, options] )
  3. result is the absolute row number (independend of the current value of start_row)
  4. available options are 0 (default), 4 (back), 32 (best match)