mrmeshpy.Dipoles Class Reference

Public Member Functions
None	__init__ (self)
None	__init__ (self, int size)
None	__init__ (self, int size, Dipole val)
None	__init__ (self, std_vector_Dipole vec)
None	__init__ (self, Dipoles arg0)
typing.Iterator[Dipole]	__iter__ (self)
Dipole	autoResizeAt (self, NodeId i)
None	autoResizeSet (self, NodeId pos, int len, Dipole val)
None	autoResizeSet (self, NodeId i, Dipole val)
Dipole	back (self)
Dipole	back (self)
NodeId	backId (self)
NodeId	beginId (self)
int	capacity (self)
None	clear (self)
Dipole	data (self)
Dipole	data (self)
bool	empty (self)
NodeId	endId (self)
Dipole	front (self)
Dipole	front (self)
int	heapBytes (self)
None	pop_back (self)
None	push_back (self, Dipole t)
None	push_back (self, Dipole t)
None	reserve (self, int capacity)
None	resize (self, int newSize)
None	resize (self, int newSize, Dipole t)
None	resizeWithReserve (self, int newSize)
None	resizeWithReserve (self, int newSize, Dipole value)
int	size (self)
None	swap (self, Dipoles b)
std_vector_Dipole	vec_ (self)
None	vec_ (self, std_vector_Dipole arg1)

Protected Member Functions
Dipole	_Subscript (self, NodeId i)
Dipole	_Subscript (self, NodeId i)

Static Protected Member Functions
	_pybind11_conduit_v1_ (*args, **kwargs)

Detailed Description

Generated from:  MR::Dipoles


 \\brief std::vector<T>-like container that requires specific indexing type,
 \\tparam T type of stored elements
 \\tparam I type of index (shall be convertible to size_t)
 \\ingroup BasicGroup

Constructor & Destructor Documentation

__init__() [1/5]

None mrmeshpy.Dipoles.__init__

(

self

)

__init__() [2/5]

None mrmeshpy.Dipoles.__init__	(		self,
		int	size )

__init__() [3/5]

None mrmeshpy.Dipoles.__init__	(		self,
		int	size,
		Dipole	val )

__init__() [4/5]

None mrmeshpy.Dipoles.__init__	(		self,
		std_vector_Dipole	vec )

__init__() [5/5]

None mrmeshpy.Dipoles.__init__	(		self,
		Dipoles	arg0 )

Implicit copy constructor.

Member Function Documentation

__iter__()

typing.Iterator[Dipole] mrmeshpy.Dipoles.__iter__

(

self

)

_pybind11_conduit_v1_()

mrmeshpy.Dipoles._pybind11_conduit_v1_ ( * args, ** kwargs )

staticprotected

_Subscript() [1/2]

Dipole mrmeshpy.Dipoles._Subscript ( self, NodeId i )

protected

_Subscript() [2/2]

Dipole mrmeshpy.Dipoles._Subscript ( self, NodeId i )

protected

autoResizeAt()

Dipole mrmeshpy.Dipoles.autoResizeAt	(		self,
		NodeId	i )

this accessor automatically adjusts the size of the vector

autoResizeSet() [1/2]

None mrmeshpy.Dipoles.autoResizeSet	(		self,
		NodeId	i,
		Dipole	val )

autoResizeSet() [2/2]

None mrmeshpy.Dipoles.autoResizeSet	(		self,
		NodeId	pos,
		int	len,
		Dipole	val )

sets elements [pos, pos+len) to given value, adjusting the size of the vector to include new elements

back() [1/2]

Dipole mrmeshpy.Dipoles.back

(

self

)

back() [2/2]

Dipole mrmeshpy.Dipoles.back

(

self

)

backId()

NodeId mrmeshpy.Dipoles.backId

(

self

)

returns the identifier of the back() element

beginId()

NodeId mrmeshpy.Dipoles.beginId

(

self

)

returns the identifier of the first element

capacity()

int mrmeshpy.Dipoles.capacity

(

self

)

clear()

None mrmeshpy.Dipoles.clear

(

self

)

data() [1/2]

Dipole mrmeshpy.Dipoles.data

(

self

)

data() [2/2]

Dipole mrmeshpy.Dipoles.data

(

self

)

empty()

bool mrmeshpy.Dipoles.empty

(

self

)

endId()

NodeId mrmeshpy.Dipoles.endId

(

self

)

returns backId() + 1

front() [1/2]

Dipole mrmeshpy.Dipoles.front

(

self

)

front() [2/2]

Dipole mrmeshpy.Dipoles.front

(

self

)

heapBytes()

int mrmeshpy.Dipoles.heapBytes

(

self

)

returns the amount of memory this object occupies on heap

pop_back()

None mrmeshpy.Dipoles.pop_back

(

self

)

push_back() [1/2]

None mrmeshpy.Dipoles.push_back	(		self,
		Dipole	t )

push_back() [2/2]

None mrmeshpy.Dipoles.push_back	(		self,
		Dipole	t )

reserve()

None mrmeshpy.Dipoles.reserve	(		self,
		int	capacity )

resize() [1/2]

None mrmeshpy.Dipoles.resize	(		self,
		int	newSize )

resize() [2/2]

None mrmeshpy.Dipoles.resize	(		self,
		int	newSize,
		Dipole	t )

resizeWithReserve() [1/2]

None mrmeshpy.Dipoles.resizeWithReserve	(		self,
		int	newSize )

doubles reserved memory until resize(newSize) can be done without reallocation

resizeWithReserve() [2/2]

None mrmeshpy.Dipoles.resizeWithReserve	(		self,
		int	newSize,
		Dipole	value )

doubles reserved memory until resize(newSize) can be done without reallocation

size()

int mrmeshpy.Dipoles.size

(

self

)

swap()

None mrmeshpy.Dipoles.swap	(		self,
		Dipoles	b )

vec_() [1/2]

std_vector_Dipole mrmeshpy.Dipoles.vec_

(

self

)

the user can directly manipulate the vector, anyway she cannot break anything

vec_() [2/2]

None mrmeshpy.Dipoles.vec_	(		self,
		std_vector_Dipole	arg1 )

---

The documentation for this class was generated from the following file:

• mrmeshpy.pyi