Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed GenTraversableOnce.
Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed GenTraversableOnce.
the GenTraversableOnce of Char to append
a new NonEmptyString that contains this NonEmptyString followed by all characters of other.
Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed Every.
Returns a new NonEmptyString containing this NonEmptyString followed by the characters of the passed Every.
the Every of Char to append
a new NonEmptyString that contains this NonEmptyString followed by all characters of other.
Returns a new NonEmptyString containing this NonEmptyString followed by the passed NonEmptyString.
Returns a new NonEmptyString containing this NonEmptyString followed by the passed NonEmptyString.
the NonEmptyString to append
a new NonEmptyString that contains this NonEmptyString followed by other.
Returns a new NonEmptyString with the given character prepended.
Returns a new NonEmptyString with the given character prepended.
Note that :-ending operators are right associative. A mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.
the character to prepend to this NonEmptyString
a new NonEmptyString consisting of c followed by all characters of this NonEmptyString.
Returns a new NonEmptyString with the given character appended.
Returns a new NonEmptyString with the given character appended.
Note a mnemonic for +: vs. :+ is: the COLon goes on the COLlection side.
the character to append to this NonEmptyString
a new NonEmptyString consisting of all characters of this NonEmptyString followed by the given c.
Appends all characters of this NonEmptyString to a string builder using start, end, and separator strings.
Appends all characters of this NonEmptyString to a string builder using start, end, and separator strings. The written text will consist of a concatenation of
the string start; the result of invoking toString on all characters of this NonEmptyString,
separated by the string sep; and the string end
the string builder to which characters will be appended
the starting string
the separator string
the ending string
the string builder, sb, to which characters were appended.
Appends all characters of this NonEmptyString to a string builder using a separator string.
Appends all characters of this NonEmptyString to a string builder using a separator string. The written text will consist of a concatenation of the
result of invoking toString
on of every character of this NonEmptyString, separated by the string sep.
the string builder to which characters will be appended
the separator string
the string builder, sb, to which characters were appended.
Appends all characters of this NonEmptyString to a string builder.
Appends all characters of this NonEmptyString to a string builder. The written text will consist of a concatenation of the result of invoking toString
on of every element of this NonEmptyString, without any separator string.
the string builder to which characters will be appended
the string builder, sb, to which elements were appended.
Selects a character by its index in the NonEmptyString.
Selects a character by its index in the NonEmptyString.
the character of this NonEmptyString at index idx, where 0 indicates the first element.
Gets a character by its index in the NonEmptyString.
Gets a character by its index in the NonEmptyString.
the character of this NonEmptyString at index idx, where 0 indicates the first element.
Finds the first character of this NonEmptyString for which the given partial function is defined, if any, and applies the partial function to it.
Finds the first character of this NonEmptyString for which the given partial function is defined, if any, and applies the partial function to it.
the partial function
an Option containing pf applied to the first character for which it is defined, or None if
the partial function was not defined for any character.
Indicates whether this NonEmptyString contains a given value as an character.
Indicates whether this NonEmptyString contains a given value as an character.
the element to look for
true if this NonEmptyString has an character that is equal (as determined by ==) to c, false otherwise.
Indicates whether this NonEmptyString contains a given NonEmptyString as a slice.
Indicates whether this NonEmptyString contains a given NonEmptyString as a slice.
the NonEmptyString slice to look for
true if this NonEmptyString contains a slice with the same characters as that, otherwise false.
Indicates whether this NonEmptyString contains a given Every of character as a slice.
Indicates whether this NonEmptyString contains a given Every of character as a slice.
the Every character slice to look for
true if this NonEmptyString contains a character slice with the same characters as that, otherwise false.
Indicates whether this NonEmptyString contains a given GenSeq of characters as a slice.
Indicates whether this NonEmptyString contains a given GenSeq of characters as a slice.
the GenSeq character slice to look for
true if this NonEmptyString contains a slice with the same characters as that, otherwise false.
Copies characters of this NonEmptyString to an array.
Copies characters of this NonEmptyString to an array. Fills the given array arr with at most len characters of this NonEmptyString, beginning at
index start. Copying will stop once either the end of the current NonEmptyString is reached, the end of the array is reached, or
len elements have been copied.
the array to fill
the starting index
the maximum number of elements to copy
Copies characters of this NonEmptyString to an array.
Copies characters of this NonEmptyString to an array. Fills the given array arr with characters of this NonEmptyString, beginning at
index start. Copying will stop once either the end of the current NonEmptyString is reached, or the end of the array is reached.
the array to fill
the starting index
Copies characters of this NonEmptyString to an array.
Copies characters of this NonEmptyString to an array. Fills the given array arr with characters of this NonEmptyString. Copying
will stop once either the end of the current NonEmptyString is reached, or the end of the array is reached.
the array to fill
Copies all characters of this NonEmptyString to a buffer.
Copies all characters of this NonEmptyString to a buffer.
the buffer to which characters are copied
Indicates whether every character of this NonEmptyString relates to the corresponding character of a given NonEmptyString by satisfying a given predicate.
Indicates whether every character of this NonEmptyString relates to the corresponding character of a given NonEmptyString by satisfying a given predicate.
the NonEmptyString to compare for correspondence
the predicate, which relates elements from this and the passed NonEmptyString
true if this and the passed NonEmptyString have the same length and p(x, y) is true
for all corresponding characters x of this NonEmptyString and y of that, otherwise false.
Indicates whether every character of this NonEmptyString relates to the corresponding element of a given Every by satisfying a given predicate.
Indicates whether every character of this NonEmptyString relates to the corresponding element of a given Every by satisfying a given predicate.
the type of the elements of that
the Every to compare for correspondence
the predicate, which relates elements from this NonEmptyString and the passed Every
true if this NonEmptyString and the passed Every have the same length and p(x, y) is true
for all corresponding elements x of this NonEmptyString and y of that, otherwise false.
Indicates whether every character of this NonEmptyString relates to the corresponding element of a given GenSeq by satisfying a given predicate.
Indicates whether every character of this NonEmptyString relates to the corresponding element of a given GenSeq by satisfying a given predicate.
the type of the elements of that
the GenSeq to compare for correspondence
the predicate, which relates elements from this NonEmptyString and the passed GenSeq
true if this NonEmptyString and the passed GenSeq have the same length and p(x, y) is true
for all corresponding elements x of this NonEmptyString and y of that, otherwise false.
Counts the number of characters in this NonEmptyString that satisfy a predicate.
Counts the number of characters in this NonEmptyString that satisfy a predicate.
the predicate used to test characters.
the number of characters satisfying the predicate p.
Builds a new NonEmptyString from this NonEmptyString without any duplicate characters.
Builds a new NonEmptyString from this NonEmptyString without any duplicate characters.
A new NonEmptyString that contains the first occurrence of every character of this NonEmptyString.
Indicates whether this NonEmptyString ends with the given NonEmptyString.
Indicates whether this NonEmptyString ends with the given NonEmptyString.
the NonEmptyString to test
true if this NonEmptyString has that as a suffix, false otherwise.
Indicates whether this NonEmptyString ends with the given Every.
Indicates whether this NonEmptyString ends with the given Every.
the Every to test
true if this NonEmptyString has that as a suffix, false otherwise.
Indicates whether this NonEmptyString ends with the given GenSeq of Char.
Indicates whether this NonEmptyString ends with the given GenSeq of Char.
the sequence to test
true if this NonEmptyString has that as a suffix, false otherwise.
Indicates whether a predicate holds for at least one of the characters of this NonEmptyString.
Indicates whether a predicate holds for at least one of the characters of this NonEmptyString.
the predicate used to test characters.
true if the given predicate p holds for some of the elements of this NonEmptyString, otherwise false.
Finds the first character of this NonEmptyString that satisfies the given predicate, if any.
Finds the first character of this NonEmptyString that satisfies the given predicate, if any.
the predicate used to test characters
an Some containing the first character in this NonEmptyString that satisfies p, or None if none exists.
Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString and using the characters of the resulting NonEmptyStrings.
Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString and using the characters of the resulting NonEmptyStrings.
the function to apply to each character.
a new NonEmptyString containing characters obtained by applying the given function f to each character of this NonEmptyString and concatenating
the characters of resulting NonEmptyStrings.
Folds the characters of this NonEmptyString using the specified associative binary operator.
Folds the characters of this NonEmptyString using the specified associative binary operator.
The order in which operations are performed on characters is unspecified and may be nondeterministic.
a neutral character for the fold operation; may be added to the result an arbitrary number of
times, and must not change the result (e.g., Nil for list concatenation,
0 for addition, or 1 for multiplication.)
a binary operator that must be associative
the result of applying fold operator op between all the elements and z
Applies a binary operator to a start value and all characters of this NonEmptyString, going left to right.
Applies a binary operator to a start value and all characters of this NonEmptyString, going left to right.
the result type of the binary operator.
the start value.
the binary operator.
the result of inserting op between consecutive characters of this NonEmptyString, going left to right, with the start value,
z, on the left:
op(...op(op(z, x_1), x_2), ..., x_n)where x1, ..., xn are the elements of this
NonEmptyString.
Applies a binary operator to all characters of this NonEmptyString and a start value, going right to left.
Applies a binary operator to all characters of this NonEmptyString and a start value, going right to left.
the result of the binary operator
the start value
the binary operator
the result of inserting op between consecutive characters of this NonEmptyString, going right to left, with the start value,
z, on the right:
op(x_1, op(x_2, ... op(x_n, z)...))where x1, ..., xn are the elements of this
NonEmptyString.
Indicates whether a predicate holds for all characters of this NonEmptyString.
Indicates whether a predicate holds for all characters of this NonEmptyString.
the predicate used to test characters.
true if the given predicate p holds for all characters of this NonEmptyString, otherwise false.
Applies a function f to all characters of this NonEmptyString.
Applies a function f to all characters of this NonEmptyString.
the function that is applied for its side-effect to every character. The result of function f is discarded.
Partitions this NonEmptyString into a map of NonEmptyStrings according to some discriminator function.
Partitions this NonEmptyString into a map of NonEmptyStrings according to some discriminator function.
the type of keys returned by the discriminator function.
the discriminator function.
A map from keys to NonEmptyStrings such that the following invariant holds:
(nonEmptyString.toString partition f)(k) = xs filter (x => f(x) == k)That is, every key
k is bound to a NonEmptyString of those elements x for which f(x) equals k.
Partitions characters into fixed size NonEmptyStrings.
Partitions characters into fixed size NonEmptyStrings.
the number of characters per group
An iterator producing NonEmptyStrings of size size, except the last will be truncated if the characters don't divide evenly.
Returns true to indicate this NonEmptyString has a definite size, since all NonEmptyStrings are strict collections.
Returns true to indicate this NonEmptyString has a definite size, since all NonEmptyStrings are strict collections.
Selects the first character of this NonEmptyString.
Selects the first character of this NonEmptyString.
the first character of this NonEmptyString.
Selects the first character of this NonEmptyString and returns it wrapped in a Some.
Selects the first character of this NonEmptyString and returns it wrapped in a Some.
the first character of this NonEmptyString, wrapped in a Some.
Finds index of first occurrence of some value in this NonEmptyString after or at some start index.
Finds index of first occurrence of some value in this NonEmptyString after or at some start index.
the character value to search for.
the start index
the index >= from of the first element of this NonEmptyString that is equal (as determined by ==) to elem,
or -1, if none exists.
Finds index of first occurrence of some value in this NonEmptyString.
Finds index of first occurrence of some value in this NonEmptyString.
the character value to search for.
the index of the first character of this NonEmptyString that is equal (as determined by ==) to c,
or -1, if none exists.
Finds first index after or at a start index where this NonEmptyString contains a given NonEmptyString as a slice.
Finds first index after or at a start index where this NonEmptyString contains a given NonEmptyString as a slice.
the NonEmptyString defining the slice to look for
the start index
the first index >= from such that the characters of this NonEmptyString starting at this index match the characters of
NonEmptyString that, or -1 of no such subsequence exists.
Finds first index after or at a start index where this NonEmptyString contains a given Every as a slice.
Finds first index after or at a start index where this NonEmptyString contains a given Every as a slice.
the Every defining the slice to look for
the start index
the first index >= from such that the characters of this NonEmptyString starting at this index match the characters of
Every that, or -1 of no such subsequence exists.
Finds first index where this NonEmptyString contains a given NonEmptyString as a slice.
Finds first index where this NonEmptyString contains a given NonEmptyString as a slice.
the NonEmptyString defining the slice to look for
the first index such that the characters of this NonEmptyString starting at this index match the characters of
NonEmptyString that, or -1 of no such subsequence exists.
Finds first index where this NonEmptyString contains a given Every as a slice.
Finds first index where this NonEmptyString contains a given Every as a slice.
the Every defining the slice to look for
the first index such that the characters of this NonEmptyString starting at this index match the characters of
Every that, or -1 of no such subsequence exists.
Finds first index after or at a start index where this NonEmptyString contains a given GenSeq[Char] as a slice.
Finds first index after or at a start index where this NonEmptyString contains a given GenSeq[Char] as a slice.
the GenSeq[Char] defining the slice to look for
the start index
the first index >= from at which the characters of this NonEmptyString starting at that index match the characters of
GenSeq[Char] that, or -1 of no such subsequence exists.
Finds first index where this NonEmptyString contains a given GenSeq[Char] as a slice.
Finds first index where this NonEmptyString contains a given GenSeq[Char] as a slice.
the GenSeq[Char] defining the slice to look for
the first index at which the elements of this NonEmptyString starting at that index match the characters of
GenSeq that, or -1 of no such subsequence exists.
Finds index of the first character satisfying some predicate after or at some start index.
Finds index of the first character satisfying some predicate after or at some start index.
the predicate used to test characters.
the start index
the index >= from of the first character of this NonEmptyString that satisfies the predicate p,
or -1, if none exists.
Finds index of the first character satisfying some predicate.
Finds index of the first character satisfying some predicate.
the predicate used to test characters.
the index of the first character of this NonEmptyString that satisfies the predicate p,
or -1, if none exists.
Produces the range of all indices of this NonEmptyString.
Produces the range of all indices of this NonEmptyString.
a Range value from 0 to one less than the length of this NonEmptyString.
Tests whether this NonEmptyString contains given index.
Tests whether this NonEmptyString contains given index.
the index to test
true if this NonEmptyString contains an character at position idx, false otherwise.
Returns false to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.
Returns false to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.
false
Returns true to indicate this NonEmptyString, like all NonEmptyStrings, can be traversed repeatedly.
Returns true to indicate this NonEmptyString, like all NonEmptyStrings, can be traversed repeatedly.
true
Creates and returns a new iterator over all characters contained in this NonEmptyString.
Creates and returns a new iterator over all characters contained in this NonEmptyString.
the new iterator
Selects the last character of this NonEmptyString.
Selects the last character of this NonEmptyString.
the last character of this NonEmptyString.
Finds the index of the last occurrence of some value in this NonEmptyString before or at a given end index.
Finds the index of the last occurrence of some value in this NonEmptyString before or at a given end index.
the character value to search for.
the end index.
the index >= end of the last character of this NonEmptyString that is equal (as determined by ==)
to elem, or -1, if none exists.
Finds the index of the last occurrence of some value in this NonEmptyString.
Finds the index of the last occurrence of some value in this NonEmptyString.
the character value to search for.
the index of the last character of this NonEmptyString that is equal (as determined by ==) to c,
or -1, if none exists.
Finds the last index before or at a given end index where this NonEmptyString contains a given NonEmptyString as a slice.
Finds the last index before or at a given end index where this NonEmptyString contains a given NonEmptyString as a slice.
the NonEmptyString defining the slice to look for
the end index
the last index >= end at which the characters of this NonEmptyString starting at that index match the characters of
NonEmptyString that, or -1 of no such subsequence exists.
Finds the last index before or at a given end index where this NonEmptyString contains a given Every as a slice.
Finds the last index before or at a given end index where this NonEmptyString contains a given Every as a slice.
the Every defining the slice to look for
the end index
the last index >= end at which the elements of this NonEmptyString starting at that index match the characters of
Every that, or -1 of no such subsequence exists.
Finds the last index where this NonEmptyString contains a given NonEmptyString as a slice.
Finds the last index where this NonEmptyString contains a given NonEmptyString as a slice.
the NonEmptyString defining the slice to look for
the last index at which the elements of this NonEmptyString starting at that index match the characters of
NonEmptyString that, or -1 of no such subsequence exists.
Finds the last index where this NonEmptyString contains a given Every as a slice.
Finds the last index where this NonEmptyString contains a given Every as a slice.
the Every defining the slice to look for
the last index at which the elements of this NonEmptyString starting at that index match the characters of
Every that, or -1 of no such subsequence exists.
Finds the last index before or at a given end index where this NonEmptyString contains a given GenSeq as a slice.
Finds the last index before or at a given end index where this NonEmptyString contains a given GenSeq as a slice.
the GenSeq defining the slice to look for
the end index
the last index >= end at which the elements of this NonEmptyString starting at that index match the characters of
GenSeq that, or -1 of no such subsequence exists.
Finds the last index where this NonEmptyString contains a given GenSeq as a slice.
Finds the last index where this NonEmptyString contains a given GenSeq as a slice.
the GenSeq defining the slice to look for
the last index at which the elements of this NonEmptyString starting at that index match the characters of
GenSeq that, or -1 of no such subsequence exists.
Finds index of last character satisfying some predicate before or at given end index.
Finds index of last character satisfying some predicate before or at given end index.
the predicate used to test characters.
the end index
the index >= end of the last character of this NonEmptyString that satisfies the predicate p,
or -1, if none exists.
Finds index of last character satisfying some predicate.
Finds index of last character satisfying some predicate.
the predicate used to test characters.
the index of the last character of this NonEmptyString that satisfies the predicate p, or -1, if none exists.
Returns the last element of this NonEmptyString, wrapped in a Some.
Returns the last element of this NonEmptyString, wrapped in a Some.
the last element, wrapped in a Some.
The length of this NonEmptyString.
The length of this NonEmptyString.
Note: length and size yield the same result, which will be >= 1.
the number of characters in this NonEmptyString.
Compares the length of this NonEmptyString to a test value.
Compares the length of this NonEmptyString to a test value.
the test value that gets compared with the length.
a value x where
x < 0 if this.length < len x == 0 if this.length == len x > 0 if this.length > len
Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString.
Builds a new NonEmptyString by applying a function to all characters of this NonEmptyString.
the character type of the returned NonEmptyString.
the function to apply to each character.
a new NonEmptyString resulting from applying the given function f to each character of this NonEmptyString and collecting the results.
Finds the largest character.
Finds the largest character.
the largest element of this NonEmptyString.
Finds the largest result after applying the given function to every character.
Finds the largest result after applying the given function to every character.
the largest result of applying the given function to every character of this NonEmptyString.
Finds the smallest character.
Finds the smallest character.
the smallest character of this NonEmptyString.
Finds the smallest result after applying the given function to every character.
Finds the smallest result after applying the given function to every character.
the smallest result of applying the given function to every character of this NonEmptyString.
Displays all characters of this NonEmptyString in a string using start, end, and separator strings.
Displays all characters of this NonEmptyString in a string using start, end, and separator strings.
the starting string.
the separator string.
the ending string.
a string representation of this NonEmptyString. The resulting string begins with the string start and ends with the string
end. Inside, In the resulting string, the result of invoking toString on all characters of this NonEmptyString are
separated by the string sep.
Displays all elements of this NonEmptyString in a string using a separator string.
Displays all elements of this NonEmptyString in a string using a separator string.
the separator string
a string representation of this NonEmptyString. In the resulting string, the result of invoking toString on all elements of this
NonEmptyString are separated by the string sep.
Displays all characters of this NonEmptyString in a string.
Displays all characters of this NonEmptyString in a string.
a string representation of this NonEmptyString. In the resulting string, the result of invoking toString on all characters of this
NonEmptyString follow each other without any separator string.
Returns true to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.
Returns true to indicate this NonEmptyString, like all NonEmptyStrings, is non-empty.
true
A copy of this NonEmptyString with an element value appended until a given target length is reached.
A copy of this NonEmptyString with an element value appended until a given target length is reached.
the target length
the padding character
a new NonEmptyString consisting of all characters of this NonEmptyString followed by the minimal number of occurrences
of elem so that the resulting NonEmptyString has a length of at least len.
Produces a new NonEmptyString where a slice of characters in this NonEmptyString is replaced by another NonEmptyString
Produces a new NonEmptyString where a slice of characters in this NonEmptyString is replaced by another NonEmptyString
the index of the first replaced character
the NonEmptyString whose characters should replace a slice in this NonEmptyString
the number of characters to drop in the original NonEmptyString
Iterates over distinct permutations.
Iterates over distinct permutations.
Here's an example:
NonEmptyString("abb").permutations.toList == list(NonEmptyString("abb"), NonEmptyString("bab"), NonEmptyString("bba"))
an iterator that traverses the distinct permutations of this NonEmptyString.
Returns the length of the longest prefix whose characters all satisfy some predicate.
Returns the length of the longest prefix whose characters all satisfy some predicate.
the predicate used to test characters.
the length of the longest prefix of this NonEmptyString such that every characters
of the segment satisfies the predicate p.
The result of multiplying all the characters of this NonEmptyString.
The result of multiplying all the characters of this NonEmptyString.
This method can be invoked for any NonEmptyString for which an implicit Numeric[T] exists.
the product of all elements
Reduces the elements of this NonEmptyString using the specified associative binary operator.
Reduces the elements of this NonEmptyString using the specified associative binary operator.
The order in which operations are performed on characters is unspecified and may be nondeterministic.
a binary operator that must be associative.
the result of applying reduce operator op between all the characters of this NonEmptyString.
Applies a binary operator to all characters of this NonEmptyString, going left to right.
Applies a binary operator to all characters of this NonEmptyString, going left to right.
the binary operator.
the result of inserting op between consecutive characters of this NonEmptyString, going left to right:
op(...op(op(x_1, x_2), x_3), ..., x_n)where x1, ..., xn are the characters of this
NonEmptyString.
Applies a binary operator to all characters of this NonEmptyString, going left to right, returning the result in a Some.
Applies a binary operator to all characters of this NonEmptyString, going left to right, returning the result in a Some.
the binary operator.
a Some containing the result of reduceLeft(op)
Applies a binary operator to all characters of this NonEmptyString, going right to left.
Applies a binary operator to all characters of this NonEmptyString, going right to left.
the binary operator
the result of inserting op between consecutive characters of this NonEmptyString, going right to left:
op(x_1, op(x_2, ... op(x_{n-1}, x_n)...))
where x1, ..., xn are the elements of this NonEmptyString.
Applies a binary operator to all elements of this NonEmptyString, going right to left, returning the result in a Some.
Applies a binary operator to all elements of this NonEmptyString, going right to left, returning the result in a Some.
the binary operator
a Some containing the result of reduceRight(op)
Returns new NonEmptyString with characters in reverse order.
Returns new NonEmptyString with characters in reverse order.
a new NonEmptyString with all characters of this NonEmptyString in reversed order.
An iterator yielding characters in reverse order.
An iterator yielding characters in reverse order.
Note: nonEmptyString.reverseIterator is the same as nonEmptyString.reverse.iterator, but might be more efficient.
an iterator yielding the characters of this NonEmptyString in reversed order
Builds a new GenIterable by applying a function to all characters of this NonEmptyString and collecting the results in reverse order.
Builds a new GenIterable by applying a function to all characters of this NonEmptyString and collecting the results in reverse order.
Note: nonEmptyString.reverseMap(f) is the same as nonEmptyString.reverse.map(f), but might be more efficient.
the element type of the returned GenIterable.
the function to apply to each character.
a new GenIterable resulting from applying the given function f to each character of this NonEmptyString
and collecting the results in reverse order.
Checks if the given NonEmptyString contains the same characters in the same order as this NonEmptyString.
Checks if the given NonEmptyString contains the same characters in the same order as this NonEmptyString.
the NonEmptyString with which to compare
true, if both this and the given NonEmptyString contain the same characters
in the same order, false otherwise.
Checks if the given Every contains the same characters in the same order as this NonEmptyString.
Checks if the given Every contains the same characters in the same order as this NonEmptyString.
the Every with which to compare
true, if both this and the given Every contain the same characters
in the same order, false otherwise.
Checks if the given GenIterable contains the same characters in the same order as this NonEmptyString.
Checks if the given GenIterable contains the same characters in the same order as this NonEmptyString.
the GenIterable with which to compare
true, if both this NonEmptyString and the given GenIterable contain the same characters
in the same order, false otherwise.
Computes a prefix scan of the characters of this NonEmptyString.
Computes a prefix scan of the characters of this NonEmptyString.
Note: The neutral character z may be applied more than once.
Here are some examples:
NonEmptyString("123").scan(0)(_ + _) == NonEmptyString(0, 1, 3, 6)
NonEmptyString("123").scan("z")(_ + _.toString) == NonEmptyString("z", "z1", "z12", "z123")
a neutral element for the scan operation; may be added to the result an arbitrary number of
times, and must not change the result (e.g., Nil for list concatenation,
0 for addition, or 1 for multiplication.)
a binary operator that must be associative
a new NonEmptyString containing the prefix scan of the elements in this NonEmptyString
Produces a NonEmptyString containing cumulative results of applying the operator going left to right.
Produces a NonEmptyString containing cumulative results of applying the operator going left to right.
Here are some examples:
NonEmptyString("123").scanLeft(0)(_ + _.toString.toInt) == Vector(0, 1, 3, 6)
NonEmptyString("123").scanLeft("z")(_ + _) == Vector("z", "z1", "z12", "z123")
the result type of the binary operator and type of the resulting NonEmptyString
the start value.
the binary operator.
a new NonEmptyString containing the intermediate results of inserting op between consecutive characters of this NonEmptyString,
going left to right, with the start value, z, on the left.
Produces a NonEmptyString containing cumulative results of applying the operator going right to left.
Produces a NonEmptyString containing cumulative results of applying the operator going right to left.
Here are some examples:
NonEmptyString("123").scanRight(0)(_.toString.toInt + _) == NonEmptyString(6, 5, 3, 0)
NonEmptyString("123").scanRight("z")(_ + _) == NonEmptyString("123z", "23z", "3z", "z")
the result of the binary operator and type of the resulting NonEmptyString
the start value
the binary operator
a new NonEmptyString containing the intermediate results of inserting op between consecutive characters of this NonEmptyString,
going right to left, with the start value, z, on the right.
Computes length of longest segment whose characters all satisfy some predicate.
Computes length of longest segment whose characters all satisfy some predicate.
the predicate used to test elements.
the index where the search starts.
the length of the longest segment of this NonEmptyString starting from index from such that every character of the
segment satisfies the predicate p.
The size of this NonEmptyString.
The size of this NonEmptyString.
Note: length and size yield the same result, which will be >= 1.
the number of characters in this NonEmptyString.
Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.),
moving the sliding window by a given step each time.
Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.),
moving the sliding window by a given step each time.
the number of characters per group
the distance between the first characters of successive groups
an iterator producing NonEmptyStrings of size size, except the last and the only character will be truncated
if there are fewer characters than size.
Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)
Groups characters in fixed size blocks by passing a “sliding window” over them (as opposed to partitioning them, as is done in grouped.)
the number of characters per group
an iterator producing NonEmptyStrings of size size, except the last and the only element will be truncated
if there are fewer characters than size.
Sorts this NonEmptyString according to the Ordering of the result of applying the given function to every character.
Sorts this NonEmptyString according to the Ordering of the result of applying the given function to every character.
the target type of the transformation f, and the type where the Ordering ord is defined.
the transformation function mapping elements to some other domain U.
the ordering assumed on domain U.
a NonEmptyString consisting of the elements of this NonEmptyString sorted according to the Ordering where
x < y if ord.lt(f(x), f(y)).
Sorts this NonEmptyString according to a comparison function.
Sorts this NonEmptyString according to a comparison function.
The sort is stable. That is, characters that are equal (as determined by lt) appear in the same order in the
sorted NonEmptyString as in the original.
the comparison function that tests whether its first argument precedes its second argument in the desired ordering.
a NonEmptyString consisting of the elements of this NonEmptyString sorted according to the comparison function lt.
Sorts this NonEmptyString according to an Ordering.
Sorts this NonEmptyString according to an Ordering.
The sort is stable. That is, elements that are equal (as determined by lt) appear in the same order in the
sorted NonEmptyString as in the original.
the Ordering to be used to compare elements.
a NonEmptyString consisting of the characters of this NonEmptyString sorted according to the ordering defined by ord.
Indicates whether this NonEmptyString starts with the given NonEmptyString at the given index.
Indicates whether this NonEmptyString starts with the given NonEmptyString at the given index.
the NonEmptyString slice to look for in this NonEmptyString
the index at which this NonEmptyString is searched.
true if this NonEmptyString has that as a slice at the index offset, false otherwise.
Indicates whether this NonEmptyString starts with the given Every at the given index.
Indicates whether this NonEmptyString starts with the given Every at the given index.
the Every slice to look for in this NonEmptyString
the index at which this NonEmptyString is searched.
true if this NonEmptyString has that as a slice at the index offset, false otherwise.
Indicates whether this NonEmptyString starts with the given NonEmptyString.
Indicates whether this NonEmptyString starts with the given NonEmptyString.
the NonEmptyString to test
true if this collection has that as a prefix, false otherwise.
Indicates whether this NonEmptyString starts with the given Every.
Indicates whether this NonEmptyString starts with the given Every.
the Every to test
true if this collection has that as a prefix, false otherwise.
Indicates whether this NonEmptyString starts with the given GenSeq at the given index.
Indicates whether this NonEmptyString starts with the given GenSeq at the given index.
the GenSeq slice to look for in this NonEmptyString
the index at which this NonEmptyString is searched.
true if this NonEmptyString has that as a slice at the index offset, false otherwise.
Indicates whether this NonEmptyString starts with the given GenSeq.
Indicates whether this NonEmptyString starts with the given GenSeq.
the GenSeq slice to look for in this NonEmptyString
true if this NonEmptyString has that as a prefix, false otherwise.
Returns "NonEmptyString", the prefix of this object's toString representation.
Returns "NonEmptyString", the prefix of this object's toString representation.
the string "NonEmptyString"
The result of summing all the characters of this NonEmptyString.
The result of summing all the characters of this NonEmptyString.
This method can be invoked for any NonEmptyString for which an implicit Numeric[Char] exists.
the sum of all elements
Converts this NonEmptyString into a collection of type Col by copying all elements.
Converts this NonEmptyString into a collection of type Col by copying all elements.
the collection type to build.
a new collection containing all elements of this NonEmptyString.
Converts this NonEmptyString to an array.
Converts this NonEmptyString to an array.
an array containing all characters of this NonEmptyString. A ClassTag must be available for the element type of this NonEmptyString.
Converts this NonEmptyString to a mutable buffer.
Converts this NonEmptyString to a mutable buffer.
a buffer containing all characters of this NonEmptyString.
Converts this NonEmptyString to an immutable IndexedSeq.
Converts this NonEmptyString to an immutable IndexedSeq.
an immutable IndexedSeq containing all characters of this NonEmptyString.
Converts this NonEmptyString to an iterable collection.
Converts this NonEmptyString to an iterable collection.
an Iterable containing all characters of this NonEmptyString.
Returns an Iterator over the elements in this NonEmptyString.
Returns an Iterator over the elements in this NonEmptyString.
an Iterator containing all characters of this NonEmptyString.
Converts this NonEmptyString to a map.
Converts this NonEmptyString to a map.
This method is unavailable unless the elements are members of Tuple2, each ((K, V)) becoming a key-value pair
in the map. Duplicate keys will be overwritten by later keys.
a map of type immutable.Map[Int, Char] containing all index/character pairs of type (Int, Char) of this NonEmptyString.
Converts this NonEmptyString to an immutable IndexedSeq.
Converts this NonEmptyString to an immutable IndexedSeq.
an immutable IndexedSeq containing all characters of this NonEmptyString.
Converts this NonEmptyString to a set.
Converts this NonEmptyString to a set.
a set containing all characters of this NonEmptyString.
Converts this NonEmptyString to a stream.
Converts this NonEmptyString to a stream.
a stream containing all characters of this NonEmptyString.
Returns a string representation of this NonEmptyString.
Returns a string representation of this NonEmptyString.
the string "NonEmptyString" followed by the result of invoking toString on
this NonEmptyString's elements, surrounded by parentheses.
Converts this NonEmptyString to a Vector.
Converts this NonEmptyString to a Vector.
a Vector containing all characters of this NonEmptyString.
Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given GenSeq.
Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given GenSeq.
nonEmptyStringX union ys is equivalent to nonEmptyStringX ++ ys.
Another way to express this is that nonEmptyStringX union ys computes the order-presevring multi-set union
of nonEmptyStringX and ys. This union method is hence a counter-part of diff and intersect that
also work on multi-sets.
the GenSeq to add.
a new NonEmptyString that contains all elements of this NonEmptyString followed by all elements of that GenSeq.
Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given NonEmptyString.
Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given NonEmptyString.
nonEmptyStringX union nonEmptyStringY is equivalent to nonEmptyStringX ++ nonEmptyStringY.
Another way to express this is that nonEmptyStringX union nonEmptyStringY computes the order-presevring multi-set union
of nonEmptyStringX and nonEmptyStringY. This union method is hence a counter-part of diff and intersect that
also work on multi-sets.
the NonEmptyString to add.
a new NonEmptyString that contains all elements of this NonEmptyString followed by all characters of that.
Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given Every.
Produces a new NonEmptyString that contains all characters of this NonEmptyString and also all characters of a given Every.
nonEmptyStringX union everyY is equivalent to nonEmptyStringX ++ everyY.
Another way to express this is that nonEmptyStringX union everyY computes the order-presevring multi-set union
of nonEmptyStringX and everyY. This union method is hence a counter-part of diff and intersect that
also work on multi-sets.
the Every to add.
a new NonEmptyString that contains all characters of this NonEmptyString followed by all characters of that Every.
Converts this NonEmptyString of pairs into two NonEmptyStrings of the first and second half of each pair.
Converts this NonEmptyString of pairs into two NonEmptyStrings of the first and second half of each pair.
the type of the first half of the character pairs
the type of the second half of the character pairs
an implicit conversion that asserts that the character type of this NonEmptyString is a pair.
a pair of NonEmptyStrings, containing the first and second half, respectively, of each character pair of this NonEmptyString.
Converts this NonEmptyString of triples into three NonEmptyStrings of the first, second, and and third character of each triple.
Converts this NonEmptyString of triples into three NonEmptyStrings of the first, second, and and third character of each triple.
the type of the first member of the character triples
the type of the third member of the character triples
an implicit conversion that character that the character type of this NonEmptyString is a triple.
a triple of NonEmptyStrings, containing the first, second, and third member, respectively, of each character triple of this NonEmptyString.
A copy of this NonEmptyString with one single replaced character.
A copy of this NonEmptyString with one single replaced character.
the position of the replacement
the replacing character
a copy of this NonEmptyString with the character at position idx replaced by c.
IndexOutOfBoundsException if the passed index is greater than or equal to the length of this NonEmptyString
Returns a NonEmptyString formed from this NonEmptyString and another NonEmptyString combining corresponding
elements in pairs.
Returns a NonEmptyString formed from this NonEmptyString and another NonEmptyString combining corresponding
elements in pairs. If one of the two is shorter than the other, placeholder elements will be used to extend the
shorter collection to the length of the longer.
the NonEmptyString providing the second half of each result pair
the character to be used to fill up the result if this NonEmptyString is shorter than that NonEmptyString.
the character to be used to fill up the result if that Iterable is shorter than this NonEmptyString.
a new NonEmptyString containing pairs consisting of corresponding characters of this NonEmptyString and that. The
length of the returned collection is the maximum of the lengths of this NonEmptyString and that. If this NonEmptyString
is shorter than that, thisElem values are used to pad the result. If that is shorter than this
NonEmptyString, thatElem values are used to pad the result.
Returns a NonEmptyString formed from this NonEmptyString and an iterable collection by combining corresponding
elements in pairs.
Returns a NonEmptyString formed from this NonEmptyString and an iterable collection by combining corresponding
elements in pairs. If one of the two collections is shorter than the other, placeholder elements will be used to extend the
shorter collection to the length of the longer.
the element type of the other
the Iterable providing the second half of each result pair
the element to be used to fill up the result if this NonEmptyString is shorter than that Iterable.
the element to be used to fill up the result if that Iterable is shorter than this NonEmptyString.
a new NonEmptyString containing pairs consisting of corresponding characters of this NonEmptyString and that. The
length of the returned collection is the maximum of the lengths of this NonEmptyString and that. If this NonEmptyString
is shorter than that, thisElem values are used to pad the result. If that is shorter than this
NonEmptyString, thatElem values are used to pad the result.
Zips this NonEmptyString with its indices.
Zips this NonEmptyString with its indices.
A new NonEmptyString containing pairs consisting of all elements of this NonEmptyString paired with their index. Indices start at 0.
A non-empty list: an ordered, immutable, non-empty collection of elements with
LinearSeqperformance characteristics.The purpose of
NonEmptyStringis to allow you to express in a type that aStringis non-empty, thereby eliminating the need for (and potential exception from) a run-time check for non-emptiness. For a non-empty sequence withIndexedSeqperformance, seeEvery.Constructing
NonEmptyStringsYou can construct a
NonEmptyStringby passing one or more elements to theNonEmptyString.applyfactory method:Alternatively you can cons elements onto the
Endsingleton object, similar to making aStringstarting withNil:Note that although
Nilis aString[Nothing],Endis not aNonEmptyString[Nothing], because no emptyNonEmptyStringexists. (A non-empty list is a series of connected links; if you have no links, you have no non-empty list.)scala> val nil: String[Nothing] = Nil nil: String[Nothing] = String() scala> val nada: NonEmptyString[Nothing] = End <console>:16: error: type mismatch; found : org.scalactic.anyvals.End.type required: org.scalactic.anyvals.NonEmptyString[Nothing] val nada: NonEmptyString[Nothing] = End ^Working with
NonEmptyStringsNonEmptyStringdoes not extend Scala'sSeqorTraversabletraits because these require that implementations may be empty. For example, if you invoketailon aSeqthat contains just one element, you'll get an emptySeq:On the other hand, many useful methods exist on
Seqthat when invoked on a non-emptySeqare guaranteed to not result in an emptySeq. For convenience,NonEmptyStringdefines a method corresponding to every suchSeqmethod. Here are some examples:NonEmptyStringdoes not currently define any methods corresponding toSeqmethods that could result in an emptySeq. However, an implicit converison fromNonEmptyStringtoStringis defined in theNonEmptyStringcompanion object that will be applied if you attempt to call one of the missing methods. As a result, you can invokefilteron anNonEmptyString, even thoughfiltercould result in an empty sequence—but the result type will beStringinstead ofNonEmptyString:You can use
NonEmptyStrings inforexpressions. The result will be anNonEmptyStringunless you use a filter (anifclause). Because filters are desugared to invocations offilter, the result type will switch to aStringat that point. Here are some examples:scala> import org.scalactic.anyvals._ import org.scalactic.anyvals._ scala> for (i <- NonEmptyString(1, 2, 3)) yield i + 1 res0: org.scalactic.anyvals.NonEmptyString[Int] = NonEmptyString(2, 3, 4) scala> for (i <- NonEmptyString(1, 2, 3) if i < 10) yield i + 1 res1: String[Int] = String(2, 3, 4) scala> for { | i <- NonEmptyString(1, 2, 3) | j <- NonEmptyString('a', 'b', 'c') | } yield (i, j) res3: org.scalactic.anyvals.NonEmptyString[(Int, Char)] = NonEmptyString((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c)) scala> for { | i <- NonEmptyString(1, 2, 3) if i < 10 | j <- NonEmptyString('a', 'b', 'c') | } yield (i, j) res6: String[(Int, Char)] = String((1,a), (1,b), (1,c), (2,a), (2,b), (2,c), (3,a), (3,b), (3,c))