StructSome

Used to iterate over a struct and test whether ANY items meet the test callback.

The function will be passed 3 arguments: the key, the value, and the struct. You can alternatively pass a Java BiPredicate which will only receive the first 2 args. The function should return true if the item meets the test, and false otherwise.

Note: This operation is a short-circuit operation, meaning it will stop iterating as soon as it finds the first item that meets the test condition.

Parallel Execution

If the parallel argument is set to true, and no max_threads are sent, the filter will be executed in parallel using a ForkJoinPool with parallel streams. If max_threads is specified, it will create a new ForkJoinPool with the specified number of threads to run the filter in parallel, and destroy it after the operation is complete. Please note that this may not be the most efficient way to iterate, as it will create a new ForkJoinPool for each invocation of the BIF. You may want to consider using a shared ForkJoinPool for better performance.

Method Signature

StructSome(struct=[structloose], callback=[function:BiPredicate], parallel=[boolean], maxThreads=[any], virtual=[boolean])

Arguments

Argument	Type	Required	Description	Default
struct	struct	true	The target struct to test
callback	function:BiPredicate	true	The function used to test. The function will be passed 3 arguments: the key, the value, the struct. You can alternatively pass a Java BiPredicate which will only receive the first 2 args.
parallel	boolean	false	Whether to run the filter in parallel. Defaults to false. If true, the filter will be run in parallel using a ForkJoinPool.	false
maxThreads	any	false	The maximum number of threads to use when running the filter in parallel. If not passed it will use the default number of threads for the ForkJoinPool. If parallel is false, this argument is ignored. If parallel is true and maxThreads is not passed, it will use the common ForkJoinPool.
virtual	boolean	false	Whether to use a virtual thread for each task when running in parallel. Defaults to false. Ignored if parallel is false.	false

Examples

The simple StructSome example

Here we have simple example about structsome function.

<bx:script>
	struct = {
		"Name" : "Raja",
		"age" : 20,
		"mark" : 80
	};
	result = structSome( struct, ( Any key, Any value ) => {
		return key == "Name";
	} );
	writeOutput( (result ? "" : "No") & " Key Exists." );
</bx:script>

Result: Key Exists.

The structSome member function example

Here we have simple example about structsome as member function.

<bx:script>
	struct = {
		"Name" : "Raja",
		"age" : 20,
		"mark" : 80
	};
	result = struct.some( ( Any key, Any value ) => {
		return key == "average";
	} );
	writeOutput( (result ? "" : "No") & " Key Exists." );
</bx:script>

Result: No Key Exists.

Additional Examples

Run Example

st = { 
	1 : {
		ACTIVE : true
	},
	2 : {
		ACTIVE : false
	},
	3 : {
		ACTIVE : false
	}
};
result = structSome( st, ( Any key, Any value ) => {
	dump( var=value, label=key );
	return value.ACTIVE;
} );
dump( result );

Related

• StructAppend
• StructClear
• StructCopy
• StructDelete
• StructEach
• StructEquals
• StructEvery
• StructFilter
• StructFind
• StructFindKey
• StructFindValue
• StructGet
• StructGetMetadata
• StructInsert
• StructIsCaseSensitive
• StructIsOrdered
• StructKeyArray
• StructKeyExists
• StructKeyList
• StructKeyTranslate
• StructMap
• StructNew
• StructNone
• StructReduce
• StructSort
• StructToQueryString
• StructToSorted
• StructUpdate
• StructValueArray