A newer version of Max is available. Click here to access the latest version of the documentation

bag Reference

Store a collection of numbers

bag

Description

Stores and manages a collection of numbers. You can add to or delete an integer from a bag as report its contents. bag with any argument maintains multiple entries with the same item; otherwise it holds only one of each.

Examples

Store a collection of numbers........ Used here to detect held notes

Arguments

duplicate-flag [symbol]

Optional

The presence of any symbol argument causes the bag to store duplicate values. If there is no argument, bag will store only one of each number at a time.

Attributes

Common Box Attributes

Messages

bang

In left inlet: Causes bag to send all its collected numbers out the outlet.

int

Arguments

input [int]
In left inlet: The number is either added to or deleted from the collection of numbers stored in the bag object, depending on the number in the right inlet.

In right inlet: The number is stored as an indicator of whether to include or delete the next number received in the left inlet. If non-zero, the number received in the left inlet is added to the bag. If 0, the number is deleted from the collection.

No output is triggered by a number received in either inlet.

  (inlet1)

Arguments

function [int]
In right inlet: The number is stored as an indicator of whether to include or delete the next number received in the left inlet. If non-zero, the number received in the left inlet is added to the bag. If 0, the number is deleted from the bag.

No output is triggered by a number received in either inlet.

float

Arguments

input [float]
Converted to int.

clear

In left inlet: Deletes the entire contents of the bag.

cut

In left inlet: Sends out the oldest (earliest received) number stored in the bag object, and deletes it from the bag.

length

In left inlet: Reports how many numbers are currently stored in the bag.

send

Arguments

receive-name [list]
In left inlet: The word send, followed by the name of a receive object, sends the result of a bang message to all receive objects with that name, instead of out the bag object's outlet.

list

Arguments

input [int]
function [int]
Any list composed of two numbers behaves as though the first list item was sent to the left inlet and the second list item was sent to the right inlet. If the second element of the list is a non-zero number, the number is added to the collection.

Output

int

When bang is received in the left inlet, all the numbers stored in bag are sent out one at a time, in reverse order from that in which they were stored.

When cut is received in the left inlet, the oldest stored number is sent out.

When length is received in the left inlet, the number of items in the bag object is sent out.

See Also

Name Description
coll
funbuff
offer