|
GROUPS Function
Extracts group(s) of adjacent characters from a text-string.
The characters to include in the group are defined by GroupType. GroupType can either be a Regular Expression pattern or a number for pre-defined group types:
0 – Numeric Digits (0-9)
1 – Alphabetic characters (a-zA-Z)
2 – All characters except numeric digits 0-9
3 – Numeric Digits 0-9 and the decimal separator character
4 – All characters except numeric digits 0-9 and the decimal separator character
You can choose either to select all groups or the nth group from the start or end of the text-string.
You can set the maximum number of characters to be returned, either from the left or the right of the result set of characters.
You can also control the start and end point of the search for groups within the text-string.
GROUPS is a multi-threaded, non-volatile function. GROUPS is not an array function.
GROUPS Syntax
GROUPS (Text, GroupNumber, MaxChars, GroupType, StartPos, EndPos)
Text (Required)
The text to extract the groups of characters from. Can be a range or a constant or any expression that returns a string.
GroupNumber (Optional, default 1)
The position number of the group to be extracted from within the text-string.
A value of zero extracts all the groups within the text-string and concatenates all the groups of characters.
A positive number extracts the Nth group from the start of the text-string, working forwards.
A negative number extracts the Nth group from the end of the text-string, working backwards.
MaxChars (Optional, default 0)
The maximum number of characters to be returned. A value of zero returns all the extracted characters. A positive number restricts the number of characters starting from the left: for example 3 would return only at most the 3 leftmost characters from the extracted characters. A negative number restricts the number of characters starting from the right, so a value of -3 would return only at most the 3 rightmost characters from the extracted characters.
GroupType (Optional, default 0)
Defines the type of characters to be considered as part of a group and returned. If GroupType is a string it will be treated as a regular expression pattern that defines which characters that will be considered part of a group. If GroupType is a number it will select one of the pre-defined Regular Expression patterns.
Any characters not defined as part of a group will act as separator characters between groups.
The numbers for the pre-defined patterns, with their equivalent Regular Expression patterns, are:
0 – (Default) Groups of adjacent numeric characters (0-9) will be returned: “[0-9]”
1 – Groups of adjacent alphabetic characters (a-z and A-Z) will be returned: “[a-zA-Z]”
2 – Groups of adjacent non-numeric characters will be returned: “[^0-9]”
3 – Groups of adjacent numeric characters (0-9) and the decimal separator will be returned: “[0-9.]”
4 – All adjacent characters except numeric characters (0-9) and the decimal separator will be returned: “[^0-9.]”
StartPos (Optional, default 1)
The position of the first character within Text to be considered as potentially part of a group. The position of the first character in Text is 1.
EndPos (Optional, default 0)
The position of the last character within Text to be considered as potentially part of a group. 0 signifies the last character in Text. The position of the first character in Text is 1.
Use StartPos and EndPos to limit the part of Text to be searched for groups.
GROUPS Examples:
There is an examples workbook in the FastExcel V4 SpeedTools install directory
If A1 contains the text string 123_abc45.zz06x then
GroupType Examples
GROUPS(A1,0) returns 1234506 (default group type is the numbers)
GROUPS(A1,0,,1) returns abczzx (all the alpha characters)
GROUPS(A1,0,,2) returns _abc.zzx (all the characters that are not numbers)
GROUPS(A1,0,,3) returns 12345.06 (numbers and decimal separator)
GROUPS(A1,0,,4) returns _abczzx (all the characters that are not numbers or decimal separator)
GROUPS(A1,0,,”[xyzb]”) returns bzzx (all the characters that match the Regular Expression pattern)
GroupNumber Examples
GROUPS(A1,2) returns 45 (the second group of numbers from the left)
GROUPS(A1,2,,1) returns zz (the second group of alpha characters from the left)
GROUPS(A1,1,,2) returns _abc (the first group of non-numeric characters from the left)
GROUPS(A1,-1,,1) returns x (the first group of alpha characters from the right)
GROUPS(A1,-1) returns 06 (the first group of numbers from the right)
GROUPS(A1,0,3) returns 123 (the leftmost 3 numbers of all the numbers)
GROUPS(“123.4567”,1) returns 123 (the decimal point is not a numeric character so the first group of numbers is returned)
GROUPS(“123.4567”,2) returns 4567 (the decimal point is not a numeric character so the second group of numbers is returned)
MaxChars Examples
GROUPS(A1,0,-4) returns 4506 (the rightmost 4 numbers of all the numbers)
GROUPS(A1,1,-2) returns 23 (the rightmost 2 numbers from the first group of numbers)
GROUPS(A1,1,99) returns 123 (up to 99 numbers from the first group of numbers)
StartPos and EndPos Examples
GROUPS(A1,0,0,0,9) returns 506
GROUPS(A1,0,0,0,9,13) returns 50
|
