April 2024 - This site, and Kamaelia are being updated. There is significant work needed, and PRs are welcome.

Kamaelia.Util.Max

  • component Max

Find the maximum of a set of values

Send a list of values to Max and it will send out the maximum value in the list.

Example Usage

Supplying three lists of items, and the greatest is selected from each.

>>> Pipeline( DataSource( [ (1,4,2,3), ('d','a','b','c'), ('xx','xxx') ] ),
              Max(),
              ConsoleEchoer(),
            ).run()

When run this will output:

4dxxx

Behaviour

Send a list of comparable items to the "inbox" inbox and the greatest of those items (the maximum of the list) will be sent out of the "outbox" outbox.

If a producerFinished or shutdownMicroprocess message is received on the "control" inbox. It is immediately sent on out of the "signal" outbox and the component then immediately terminates.


Kamaelia.Util.Max.Max

class Max(Axon.Component.component)

Max() -> new Max component.

Send a list of values to its "inbox" inbox, and the maximum value from that list is sent out the "outbox" outbox.

Inboxes

  • control : Shutdown signalling
  • inbox : Lists of values

Outboxes

  • outbox : Maximum value from the lists
  • signal : Shutdown signalling

Methods defined here

Warning!

You should be using the inbox/outbox interface, not these methods (except construction). This documentation is designed as a roadmap as to their functionalilty for maintainers and new component developers.

main(self)

Main loop

Feedback

Got a problem with the documentation? Something unclear that could be clearer? Want to help improve it? Constructive criticism is very welcome - especially if you can suggest a better rewording!

Please leave you feedback here in reply to the documentation thread in the Kamaelia blog.

-- Automatic documentation generator, 05 Jun 2009 at 03:01:38 UTC/GMT