array_split
0.6.xdev2

Read Me

  • Introduction
  • Quick Start Example
  • Installation
  • Requirements
  • Testing
  • Documentation
  • Latest source code
  • Bug Reports
  • Contributing
  • License information

Examples

  • Terminology
  • Parameter Categories
  • Import statements for the examples
  • array_split, shape_split and ShapeSplitter
  • Splitting by number of tiles
    • Single axis number of tiles
    • Multiple axes number of tiles
  • Splitting by per-axis cut indices
    • Single axis cut indices
    • Multiple axes cut indices
  • Splitting by tile shape
  • Splitting by maximum bytes per tile
    • Tile shape upper bound constraint
    • Sub-tile shape constraint
  • The array_start parameter
  • The halo parameter

API Reference

  • The array_split Package
    • Classes and Functions
      • array_split.shape_split
      • array_split.array_split
      • array_split.ShapeSplitter
        • array_split.ShapeSplitter.__init__
        • array_split.ShapeSplitter.calculate_axis_split_extents
        • array_split.ShapeSplitter.calculate_split
        • array_split.ShapeSplitter.calculate_split_by_indices_per_axis
        • array_split.ShapeSplitter.calculate_split_by_split_size
        • array_split.ShapeSplitter.calculate_split_by_tile_max_bytes
        • array_split.ShapeSplitter.calculate_split_by_tile_shape
        • array_split.ShapeSplitter.calculate_split_from_extents
        • array_split.ShapeSplitter.calculate_split_halos_from_extents
        • array_split.ShapeSplitter.check_consistent_parameter_dimensions
        • array_split.ShapeSplitter.check_consistent_parameter_grouping
        • array_split.ShapeSplitter.check_split_parameters
        • array_split.ShapeSplitter.check_tile_bounds_policy
        • array_split.ShapeSplitter.convert_halo_to_array_form
        • array_split.ShapeSplitter.set_split_extents
        • array_split.ShapeSplitter.set_split_extents_by_indices_per_axis
        • array_split.ShapeSplitter.set_split_extents_by_split_size
        • array_split.ShapeSplitter.set_split_extents_by_tile_max_bytes
        • array_split.ShapeSplitter.set_split_extents_by_tile_shape
        • array_split.ShapeSplitter.update_tile_extent_bounds
        • array_split.ShapeSplitter.array_itemsize
        • array_split.ShapeSplitter.array_shape
        • array_split.ShapeSplitter.array_start
        • array_split.ShapeSplitter.halo
        • array_split.ShapeSplitter.indices_per_axis
        • array_split.ShapeSplitter.logger
        • array_split.ShapeSplitter.max_tile_bytes
        • array_split.ShapeSplitter.max_tile_shape
        • array_split.ShapeSplitter.split_begs
        • array_split.ShapeSplitter.split_ends
        • array_split.ShapeSplitter.split_num_slices_per_axis
        • array_split.ShapeSplitter.split_shape
        • array_split.ShapeSplitter.split_size
        • array_split.ShapeSplitter.sub_tile_shape
        • array_split.ShapeSplitter.tile_beg_min
        • array_split.ShapeSplitter.tile_bounds_policy
        • array_split.ShapeSplitter.tile_end_max
        • array_split.ShapeSplitter.tile_shape
        • array_split.ShapeSplitter.valid_tile_bounds_policies
    • Attributes
  • The array_split.split Module
    • Classes and Functions
      • array_split.split.shape_factors
      • array_split.split.calculate_num_slices_per_axis
      • array_split.split.calculate_tile_shape_for_max_bytes
      • array_split.split.convert_halo_to_array_form
      • array_split.split.ShapeSplitter
        • array_split.split.ShapeSplitter.__init__
        • array_split.split.ShapeSplitter.calculate_axis_split_extents
        • array_split.split.ShapeSplitter.calculate_split
        • array_split.split.ShapeSplitter.calculate_split_by_indices_per_axis
        • array_split.split.ShapeSplitter.calculate_split_by_split_size
        • array_split.split.ShapeSplitter.calculate_split_by_tile_max_bytes
        • array_split.split.ShapeSplitter.calculate_split_by_tile_shape
        • array_split.split.ShapeSplitter.calculate_split_from_extents
        • array_split.split.ShapeSplitter.calculate_split_halos_from_extents
        • array_split.split.ShapeSplitter.check_consistent_parameter_dimensions
        • array_split.split.ShapeSplitter.check_consistent_parameter_grouping
        • array_split.split.ShapeSplitter.check_split_parameters
        • array_split.split.ShapeSplitter.check_tile_bounds_policy
        • array_split.split.ShapeSplitter.convert_halo_to_array_form
        • array_split.split.ShapeSplitter.set_split_extents
        • array_split.split.ShapeSplitter.set_split_extents_by_indices_per_axis
        • array_split.split.ShapeSplitter.set_split_extents_by_split_size
        • array_split.split.ShapeSplitter.set_split_extents_by_tile_max_bytes
        • array_split.split.ShapeSplitter.set_split_extents_by_tile_shape
        • array_split.split.ShapeSplitter.update_tile_extent_bounds
        • array_split.split.ShapeSplitter.array_itemsize
        • array_split.split.ShapeSplitter.array_shape
        • array_split.split.ShapeSplitter.array_start
        • array_split.split.ShapeSplitter.halo
        • array_split.split.ShapeSplitter.indices_per_axis
        • array_split.split.ShapeSplitter.logger
        • array_split.split.ShapeSplitter.max_tile_bytes
        • array_split.split.ShapeSplitter.max_tile_shape
        • array_split.split.ShapeSplitter.split_begs
        • array_split.split.ShapeSplitter.split_ends
        • array_split.split.ShapeSplitter.split_num_slices_per_axis
        • array_split.split.ShapeSplitter.split_shape
        • array_split.split.ShapeSplitter.split_size
        • array_split.split.ShapeSplitter.sub_tile_shape
        • array_split.split.ShapeSplitter.tile_beg_min
        • array_split.split.ShapeSplitter.tile_bounds_policy
        • array_split.split.ShapeSplitter.tile_end_max
        • array_split.split.ShapeSplitter.tile_shape
        • array_split.split.ShapeSplitter.valid_tile_bounds_policies
      • array_split.split.shape_split
      • array_split.split.array_split
    • Attributes
    • Utilities
      • array_split.split.is_scalar
      • array_split.split.is_sequence
      • array_split.split.is_indices
      • array_split.split.pad_with_object
      • array_split.split.pad_with_none
  • The array_split.split_test Module
    • Classes
      • array_split.split_test.SplitTest
        • array_split.split_test.SplitTest.__init__
        • array_split.split_test.SplitTest.addCleanup
        • array_split.split_test.SplitTest.addTypeEqualityFunc
        • array_split.split_test.SplitTest.assertArraySplitEqual
        • array_split.split_test.SplitTest.countTestCases
        • array_split.split_test.SplitTest.debug
        • array_split.split_test.SplitTest.defaultTestResult
        • array_split.split_test.SplitTest.doCleanups
        • array_split.split_test.SplitTest.id
        • array_split.split_test.SplitTest.run
        • array_split.split_test.SplitTest.setUp
        • array_split.split_test.SplitTest.setUpClass
        • array_split.split_test.SplitTest.shortDescription
        • array_split.split_test.SplitTest.skipTest
        • array_split.split_test.SplitTest.subTest
        • array_split.split_test.SplitTest.tearDown
        • array_split.split_test.SplitTest.tearDownClass
        • array_split.split_test.SplitTest.test_array_split
        • array_split.split_test.SplitTest.test_calculate_num_slices_per_axis
        • array_split.split_test.SplitTest.test_calculate_split_by_tile_max_bytes_1d
        • array_split.split_test.SplitTest.test_calculate_split_by_tile_shape_1d
        • array_split.split_test.SplitTest.test_calculate_split_by_tile_shape_2d
        • array_split.split_test.SplitTest.test_calculate_split_halos_from_extents
        • array_split.split_test.SplitTest.test_calculate_split_with_array_start_1d
        • array_split.split_test.SplitTest.test_calculate_split_with_array_start_2d
        • array_split.split_test.SplitTest.test_calculate_split_with_halo_1d
        • array_split.split_test.SplitTest.test_calculate_split_with_halo_2d
        • array_split.split_test.SplitTest.test_calculate_split_with_halo_for_empty_tiles
        • array_split.split_test.SplitTest.test_calculate_tile_shape_for_max_bytes_1d
        • array_split.split_test.SplitTest.test_calculate_tile_shape_for_max_bytes_2d
        • array_split.split_test.SplitTest.test_convert_halo_to_array_form
        • array_split.split_test.SplitTest.test_multiple_parameter_groups_error
        • array_split.split_test.SplitTest.test_pad_with_object
        • array_split.split_test.SplitTest.test_properties
        • array_split.split_test.SplitTest.test_shape_factors
        • array_split.split_test.SplitTest.test_split_by_num_slices_1d
        • array_split.split_test.SplitTest.test_split_by_num_slices_2d_0_axis_elems
        • array_split.split_test.SplitTest.test_split_by_num_slices_2d_non_0_axis_elems
        • array_split.split_test.SplitTest.test_split_by_per_axis_indices
        • array_split.split_test.SplitTest.logger
        • array_split.split_test.SplitTest.longMessage
        • array_split.split_test.SplitTest.maxDiff
  • The array_split.tests Module
    • Classes and Functions
      • array_split.tests.MultiPlatformAnd23Checker
        • array_split.tests.MultiPlatformAnd23Checker.check_output
        • array_split.tests.MultiPlatformAnd23Checker.output_difference
      • array_split.tests.DocTestTestSuite
        • array_split.tests.DocTestTestSuite.__init__
        • array_split.tests.DocTestTestSuite.addTest
        • array_split.tests.DocTestTestSuite.addTests
        • array_split.tests.DocTestTestSuite.countTestCases
        • array_split.tests.DocTestTestSuite.debug
        • array_split.tests.DocTestTestSuite.run
      • array_split.tests.load_tests
  • The array_split.logging Module
    • Classes and Functions
      • array_split.logging.SplitStreamHandler
        • array_split.logging.SplitStreamHandler.__init__
        • array_split.logging.SplitStreamHandler.acquire
        • array_split.logging.SplitStreamHandler.addFilter
        • array_split.logging.SplitStreamHandler.close
        • array_split.logging.SplitStreamHandler.createLock
        • array_split.logging.SplitStreamHandler.emit
        • array_split.logging.SplitStreamHandler.filter
        • array_split.logging.SplitStreamHandler.flush
        • array_split.logging.SplitStreamHandler.format
        • array_split.logging.SplitStreamHandler.get_name
        • array_split.logging.SplitStreamHandler.handle
        • array_split.logging.SplitStreamHandler.handleError
        • array_split.logging.SplitStreamHandler.release
        • array_split.logging.SplitStreamHandler.removeFilter
        • array_split.logging.SplitStreamHandler.setFormatter
        • array_split.logging.SplitStreamHandler.setLevel
        • array_split.logging.SplitStreamHandler.set_name
        • array_split.logging.SplitStreamHandler.name
        • array_split.logging.SplitStreamHandler.terminator
      • array_split.logging.initialise_loggers
      • array_split.logging.get_formatter
  • The array_split.unittest Module
    • Classes and Functions
      • array_split.unittest.main
      • array_split.unittest.TestCase
        • array_split.unittest.TestCase.__init__
        • array_split.unittest.TestCase.addCleanup
        • array_split.unittest.TestCase.addTypeEqualityFunc
        • array_split.unittest.TestCase.assertAlmostEqual
        • array_split.unittest.TestCase.assertAlmostEquals
        • array_split.unittest.TestCase.assertArraySplitEqual
        • array_split.unittest.TestCase.assertCountEqual
        • array_split.unittest.TestCase.assertDictContainsSubset
        • array_split.unittest.TestCase.assertDictEqual
        • array_split.unittest.TestCase.assertEqual
        • array_split.unittest.TestCase.assertEquals
        • array_split.unittest.TestCase.assertFalse
        • array_split.unittest.TestCase.assertGreater
        • array_split.unittest.TestCase.assertGreaterEqual
        • array_split.unittest.TestCase.assertIn
        • array_split.unittest.TestCase.assertIs
        • array_split.unittest.TestCase.assertIsInstance
        • array_split.unittest.TestCase.assertIsNone
        • array_split.unittest.TestCase.assertIsNot
        • array_split.unittest.TestCase.assertIsNotNone
        • array_split.unittest.TestCase.assertItemsEqual
        • array_split.unittest.TestCase.assertLess
        • array_split.unittest.TestCase.assertLessEqual
        • array_split.unittest.TestCase.assertListEqual
        • array_split.unittest.TestCase.assertLogs
        • array_split.unittest.TestCase.assertMultiLineEqual
        • array_split.unittest.TestCase.assertNotAlmostEqual
        • array_split.unittest.TestCase.assertNotAlmostEquals
        • array_split.unittest.TestCase.assertNotEqual
        • array_split.unittest.TestCase.assertNotEquals
        • array_split.unittest.TestCase.assertNotIn
        • array_split.unittest.TestCase.assertNotIsInstance
        • array_split.unittest.TestCase.assertNotRegex
        • array_split.unittest.TestCase.assertNotRegexpMatches
        • array_split.unittest.TestCase.assertRaises
        • array_split.unittest.TestCase.assertRaisesRegex
        • array_split.unittest.TestCase.assertRaisesRegexp
        • array_split.unittest.TestCase.assertRegex
        • array_split.unittest.TestCase.assertRegexpMatches
        • array_split.unittest.TestCase.assertSequenceEqual
        • array_split.unittest.TestCase.assertSetEqual
        • array_split.unittest.TestCase.assertTrue
        • array_split.unittest.TestCase.assertTupleEqual
        • array_split.unittest.TestCase.assertWarns
        • array_split.unittest.TestCase.assertWarnsRegex
        • array_split.unittest.TestCase.assert_
        • array_split.unittest.TestCase.countTestCases
        • array_split.unittest.TestCase.debug
        • array_split.unittest.TestCase.defaultTestResult
        • array_split.unittest.TestCase.doCleanups
        • array_split.unittest.TestCase.fail
        • array_split.unittest.TestCase.failIf
        • array_split.unittest.TestCase.failIfAlmostEqual
        • array_split.unittest.TestCase.failIfEqual
        • array_split.unittest.TestCase.failUnless
        • array_split.unittest.TestCase.failUnlessAlmostEqual
        • array_split.unittest.TestCase.failUnlessEqual
        • array_split.unittest.TestCase.failUnlessRaises
        • array_split.unittest.TestCase.id
        • array_split.unittest.TestCase.run
        • array_split.unittest.TestCase.setUp
        • array_split.unittest.TestCase.setUpClass
        • array_split.unittest.TestCase.shortDescription
        • array_split.unittest.TestCase.skipTest
        • array_split.unittest.TestCase.subTest
        • array_split.unittest.TestCase.tearDown
        • array_split.unittest.TestCase.tearDownClass
        • array_split.unittest.TestCase.longMessage
        • array_split.unittest.TestCase.maxDiff
  • The array_split.license Module
    • License
    • Copyright
    • Functions
      • array_split.license.license
      • array_split.license.copyright
      • array_split.license.version

Contributing

  • How to contribute
    • Workflow
    • Coding Guidelines
    • Code of Conduct
array_split
  • Docs »
  • array_split documentation
  • View page source

array_split documentation¶

array_split python package TravisCI Status AppVeyor Status Documentation Status Coveralls Status MIT License array_split python package https://zenodo.org/badge/DOI/10.5281/zenodo.889078.svg http://joss.theoj.org/papers/10.21105/joss.00373/status.svg
Release:0.6.xdev2-9-ge07abe3
Version:0.6.xdev2
Date:Sep 23, 2017

Read Me

  • Introduction
  • Quick Start Example
  • Installation
  • Requirements
  • Testing
  • Documentation
  • Latest source code
  • Bug Reports
  • Contributing
  • License information

Examples¶

  • Terminology
  • Parameter Categories
  • Import statements for the examples
  • array_split, shape_split and ShapeSplitter
  • Splitting by number of tiles
    • Single axis number of tiles
    • Multiple axes number of tiles
  • Splitting by per-axis cut indices
    • Single axis cut indices
    • Multiple axes cut indices
  • Splitting by tile shape
  • Splitting by maximum bytes per tile
    • Tile shape upper bound constraint
    • Sub-tile shape constraint
  • The array_start parameter
  • The halo parameter

API Reference

  • The array_split Package
    • Classes and Functions
    • Attributes
  • The array_split.split Module
    • Classes and Functions
    • Attributes
    • Utilities
  • The array_split.split_test Module
    • Classes
  • The array_split.tests Module
    • Classes and Functions
  • The array_split.logging Module
    • Classes and Functions
  • The array_split.unittest Module
    • Classes and Functions
  • The array_split.license Module
    • License
    • Copyright
    • Functions

Contributing

  • How to contribute
    • Workflow
    • Coding Guidelines
    • Code of Conduct
Next

© Copyright 2017 The Australian National University. .

Built with Sphinx using a theme provided by Read the Docs.