#include <ravelWrap.h>

Inheritance diagram for minsky::Ravel:

Collaboration diagram for minsky::Ravel:

Public Member Functions
	CLASSDESC_ACCESS (Ravel)

	Ravel ()

void	operator= (const Ravel &)

	Ravel (const Ravel &x)

const Ravel *	ravelCast () const override

Ravel *	ravelCast () override

double	radius () const

void	leaveLockGroup ()

void	broadcastStateToLockGroup () const

void	draw (cairo_t *cairo) const override
	draw this item into a cairo context More...

void	resize (const LassoBox &) override
	resize this item on the canvas More...

bool	inItem (float x, float y) const override

void	onMouseDown (float x, float y) override
	respond to mouse down events More...

void	onMouseUp (float x, float y) override
	respond to mouse up events More...

bool	onMouseMotion (float x, float y) override
	respond to mouse motion events with button pressed More...

bool	onMouseOver (float x, float y) override
	respond to mouse motion events (hover) without button pressed More...

void	onMouseLeave () override
	respond to mouse leave events (when mouse leaves item) More...

Hypercube	hypercube () const
	return hypercube corresponding to the current Ravel state More...

void	populateHypercube (const Hypercube &)

unsigned	maxRank () const

unsigned	numHandles () const

size_t	numSliceLabels (size_t axis) const
	number of slice labels along axis axis More...

void	setRank (unsigned r)
	adjust output dimensions to first r handles More...

void	adjustSlicer (int)
	adjust currently selected handle's slicer More...

bool	onKeyPress (int, const std::string &, int) override
	respond to key press events More...

void	redistributeHandles ()
	redistribute handles according to current state More...

void	nextReduction (ravel::Op::ReductionOp op)
	sets the type of the next reduction operation More...

void	handleSetReduction (int handle, ravel::Op::ReductionOp op)
	set the reduction type for handle More...

int	selectedHandle () const
	current handle mouse is over, or -1 if none More...

void	collapseAllHandles (bool collapse=true)
	collapse all handles (applying nextReduction op where appropriate) More...

bool	displayFilterCaliper () const
	enable/disable calipers on currently selected handle More...

bool	setDisplayFilterCaliper (bool x)

bool	toggleDisplayFilterCaliper ()

std::vector< std::string >	allSliceLabels () const
	returns all slice labels along the selected handle, in specified order More...

std::vector< std::string >	allSliceLabelsAxis (int axis) const
	returns all slice labels along an axis(dimension) identified by its number More...

std::vector< std::string >	pickedSliceLabels () const
	returns just the picked slice labels along the handle More...

std::vector< std::string >	pickedSliceLabels (int axis) const

void	pickSliceLabels (int axis, const std::vector< std::string > &pick)
	pick (selected) pick labels More...

std::vector< std::string >	handleNames () const
	return all handle names More...

Dimension	dimension (int handle) const
	dimension details associated with handle More...

void	resortHandleIfDynamic ()

ravel::HandleSort::Order	setHandleSortOrder (ravel::HandleSort::Order, int handle)
	set a given handle sort order More...

bool	handleSortableByValue () const

void	sortByValue (ravel::HandleSort::Order dir)
	Sort handle by value. Only applicable for rank 1 ravels. More...

std::string	description () const

void	setDescription (const std::string &)

std::string	handleDescription (int handle) const
	return the description field for handle handle. More...

void	setHandleDescription (int handle, const std::string &description)
	set the description field for handle More...

ravel::RavelState	getState () const
	get the current state of the Ravel More...

void	applyState (const ravel::RavelState &state)
	apply the state to the Ravel, leaving data, slicelabels etc unchanged More...

void	displayDelayedTooltip (float x, float y) override
	enable extended tooltip help message appropriate for mouse at (x,y) More...

void	exportAsCSV (const std::string &filename, bool tabular) const
	export the plotted data as a CSV file More...

Units	units (bool) const override
	compute the dimensional units More...

bool	editorMode () const override
	indicate whether icon is in editor mode or icon mode More...

void	toggleEditorMode () override

void	joinLockGroup (unsigned)


ravel::HandleSort::Order	sortOrder () const
	the handle sorting order for currently selected handle More...

ravel::HandleSort::Order	setSortOrder (ravel::HandleSort::Order)
	the handle sorting order for currently selected handle More...


Dimension::Type	dimensionType () const
	get/set dimension attributes of selected handle, or handle at given index More...

Dimension::Type	dimensionType (int) const
	get/set dimension attributes of selected handle, or handle at given index More...

std::string	dimensionUnitsFormat () const
	get/set dimension attributes of selected handle, or handle at given index More...

std::string	dimensionUnitsFormat (int) const
	get/set dimension attributes of selected handle, or handle at given index More...

void	setDimension (Dimension::Type type, const std::string &units)

void	setDimension (int handleIndex, Dimension::Type type, const std::string &units)

Public Member Functions inherited from minsky::ItemT< Ravel, Operation< OperationType::ravel > >
std::string	classType () const override

ItemT *	clone () const override

void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) override

void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) const override

void	json_pack (classdesc::json_pack_t &j) const override

	ItemT ()=default

	ItemT (const ItemT &)=default

	ItemT (ItemT &&)=delete

ItemT &	operator= (const ItemT &)=default

ItemT &	operator= (ItemT &&)=delete

Public Member Functions inherited from minsky::Operation< OperationType::ravel >
Type	type () const override

void	iconDraw (cairo_t *) const override
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *cairo) const
	visual representation of operation on the canvas More...

void	iconDraw (cairo_t *) const
	visual representation of operation on the canvas More...

std::size_t	numPorts () const override

	Operation ()

	Operation (const Operation &x)

	Operation (Operation &&x)

Operation &	operator= (const Operation &x)

Operation &	operator= (Operation &&x)

std::string	classType () const override

Public Member Functions inherited from minsky::ItemT< Operation< T >, OperationBase >
void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) override

void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) const override

	ItemT ()=default

	ItemT (const ItemT &)=default

	ItemT (ItemT &&)=delete

ItemT &	operator= (const ItemT &)=default

ItemT &	operator= (ItemT &&)=delete

Public Member Functions inherited from minsky::OperationBase
const OperationBase *	operationCast () const override

OperationBase *	operationCast () override

std::string	portValues () const
	returns a list of values the ports currently have More...

bool	multiWire () const

virtual void	addPorts ()

void	drawUserFunction (cairo_t *cairo) const

float	scaleFactor () const override
	factor by which item has been resized More...

double	value () const override
	current value of output port More...

std::vector< std::string >	dimensions () const
	return dimension names of tensor object attached to input if binary op, then the union of dimension names is returned More...

Public Member Functions inherited from minsky::BottomRightResizerItem
bool	onResizeHandle (float x, float y) const override

void	drawResizeHandles (cairo_t *cairo) const override

virtual Point	resizeHandleCoords () const
	returns coordinates of the resizer handle More...

Public Member Functions inherited from minsky::Item
	Item ()=default

virtual std::weak_ptr< Port >	ports (std::size_t i) const
	callback to be run when item deleted from group More...

std::size_t	portsSize () const
	number of ports More...

float	portX (std::size_t i)

float	portY (std::size_t i)

virtual bool	contains (float xx, float yy) const

bool	contains (const Point &p) const

void	updateBoundingBox () override

void	throw_error (const std::string &) const
	mark item on canvas, then throw More...

virtual bool	ioVar () const
	indicates this is a group I/O variable More...

double	rotation () const

double	rotation (const double &r)

std::pair< double, bool >	rotationAsRadians () const
	return the rotation as radians, and whether rotation should have additional straight angle added for text that stays upright. More...

float	iWidth () const

float	iWidth (const float &w)

float	iHeight () const

float	iHeight (const float &h)

virtual void	flip ()
	rotate icon though 180∘ More...

std::string	id () const
	return an id uniquely identifying this item More...

virtual float	x () const

virtual float	y () const

virtual float	zoomFactor () const

void	ensureBBValid () const

float	width () const

float	height () const

virtual std::vector< Point >	corners () const

float	left () const

float	right () const

float	top () const

float	bottom () const

std::string	bookmarkId () const
	Id of bookmark associated with this. More...

void	adjustBookmark () const override
	adjust bookmark list to reflect current configuration More...

float	resizeHandleSize () const
	resize handles should be at least a percentage if the icon size (#1025) More...

virtual bool	onItem (float x, float y) const
	returns true if (x,y) is on the icon More...

virtual void	deleteAttachedWires ()
	delete all attached wires More...

virtual bool	visible () const
	whether this item is visible on the canvas. More...

void	moveTo (float x, float y)

virtual float	scaleFactor (const float &sf)

void	dummyDraw () const
	draw into a dummy cairo context, for purposes of calculating port positions More...

virtual void	displayTooltip (cairo_t *, const std::string &) const
	display tooltip text, eg on mouseover More...

virtual void	updateIcon (double t)
	update display after a step() More...

	Item (const Item &)=default

Item &	operator= (const Item &)=default

virtual	~Item ()

void	drawPorts (cairo_t *cairo) const

virtual ClickType::Type	clickType (float x, float y) const
	returns the clicktype given a mouse click at x, y. More...

virtual std::shared_ptr< Port >	closestOutPort (float x, float y) const
	returns closest output port to x,y More...

virtual std::shared_ptr< Port >	closestInPort (float x, float y) const

virtual std::shared_ptr< Item >	select (float x, float y) const
	returns the variable if point (x,y) is within a visible variable icon, null otherwise. More...

void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) override
	runs the RESTProcess descriptor suitable for this type More...

void	RESTProcess (classdesc::RESTProcess_t &rp, const std::string &d) const override

virtual void	disableDelayedTooltip ()

Units	checkUnits () const
	perform units consistency checks More...

ItemPtr	itemPtrFromThis () const
	return a shared_ptr to this More...

virtual void	destroyFrame ()
	destroy any popup windows associated with this More...

Public Member Functions inherited from minsky::NoteBase
virtual std::string const &	detailedText () const

virtual std::string const &	detailedText (const std::string &x)

virtual std::string const &	tooltip () const

virtual std::string const &	tooltip (const std::string &x)

virtual	~NoteBase ()=default

Static Public Member Functions
static std::vector< unsigned >	lockGroupColours ()

Static Public Member Functions inherited from minsky::OperationBase
static OperationBase *	create (Type type)
	factory method. More...

Static Public Member Functions inherited from minsky::Item
static void	drawSelected (cairo_t *cairo)

Static Public Member Functions inherited from minsky::OperationType
static std::string	typeName (int type)
	return the symbolic name of type More...

static Group	classify (Type t)

Public Attributes
RavelPopup	popup
	popup Ravel control window More...

bool	flipped =false

Dimensions	axisDimensions
	local override of axis dimensionality More...

std::shared_ptr< RavelLockGroup >	lockGroup
	group of ravels that move syncronously More...

Public Attributes inherited from minsky::OperationBase
double	arg =1
	operation argument. For example, the offset used in a difference operator, or binsize in a binning op More...

std::string	axis
	axis selector in tensor operations More...

Public Attributes inherited from minsky::Item
float	m_x =0

float	m_y =0
	position in canvas, or within group More...

float	m_sf =1
	scale factor of item on canvas, or within group More...

bool	onResizeHandles =false
	set to true to indicate mouse is ovcaler resize handles More...

bool	onBorder =false
	true to indicate mouse hovering over border More...

std::string	deleteCallback

BoundingBox	bb
	canvas bounding box. More...

Public Attributes inherited from minsky::NoteBase
bool	mouseFocus =false
	true if target of a mouseover More...

bool	selected =false
	true if selected for cut, copy or group operation More...

bool	bookmark =false
	Is this item also a bookmark? More...

Static Public Attributes
static SVGRenderer	svgRenderer
	SVG icon to display when not in editor mode. More...

Static Public Attributes inherited from minsky::OperationBase
static constexpr float	l =-8

static constexpr float	h =12

static constexpr float	r =12

Private Types
using	HandleState = ravel::HandleState

Private Member Functions
std::vector< std::string >	allSliceLabelsImpl (int axis, ravel::HandleSort::Order) const

Private Attributes
const double	moveX =0.5
	position of the "move" handle, as a proportion of radius More...

const double	moveY =0.5

const double	moveSz =0.1

bool	m_editorMode =false
	indicate whether icon is in editor mode or icon mode More...

std::string	explanation

ravel::HandleSort::Order	previousOrder =ravel::HandleSort::forward

ravel::RavelState	initState
	used entirely to defer persisted state data until after first load from a variable More...

friend	RavelPopup

ravelCAPI::Ravel	wrappedRavel

ravel::Op::ReductionOp	m_nextReduction =ravel::Op::sum

Friends
struct	SchemaHelper

Additional Inherited Members
Public Types inherited from minsky::Operation< OperationType::ravel >
typedef OperationType::Type	Type

Public Types inherited from minsky::OperationBase
typedef OperationType::Type	Type

Public Types inherited from minsky::OperationType
enum	Type { constant, time, integrate, differentiate, data, ravel, euler, pi, zero, one, inf, percent, add, subtract, multiply, divide, min, max, and_, or_, log, pow, polygamma, lt, le, eq, userFunction, copy, sqrt, exp, ln, sin, cos, tan, asin, acos, atan, sinh, cosh, tanh, abs, floor, frac, not_, Gamma, fact, sum, product, infimum, supremum, any, all, infIndex, supIndex, runningSum, runningProduct, difference, differencePlus, innerProduct, outerProduct, index, gather, meld, merge, slice, size, shape, mean, median, stdDev, moment, histogram, covariance, correlation, linearRegression, numOps }

enum	Group { general, constop, binop, function, reduction, scan, tensor, statistics }

Protected Member Functions inherited from minsky::OperationBase
void	setCachedText (cairo_t *, const std::string &, double) const
	check if cachedPango is up to date, and if not recreate More...

Static Protected Member Functions inherited from minsky::Item
static void	drawResizeHandle (cairo_t *cairo, double x, double y, double sf, double angle)

Protected Attributes inherited from minsky::OperationBase
classdesc::Exclude< std::shared_ptr< ecolab::Pango > >	cachedPango

Protected Attributes inherited from minsky::Item
double	m_width =20

double	m_height =20

ItemPortVector	m_ports

minsky::Item::MemoisedRotator	memoisedRotator

Detailed Description

Definition at line 55 of file ravelWrap.h.

Member Typedef Documentation

◆ HandleState

using minsky::Ravel::HandleState = ravel::HandleState

private

Definition at line 61 of file ravelWrap.h.

Constructor & Destructor Documentation

◆ Ravel() [1/2]

minsky::Ravel::Ravel ( )

Definition at line 63 of file ravelWrap.cc.

References minsky::NoteBase::detailedText(), minsky::GroupItems::items, m_editorMode, minsky::minsky(), minsky::Minsky::model, minsky::NoteBase::tooltip(), and wrappedRavel.

               : popup(*this)
   {
     if (!wrappedRavel)
       {
         tooltip("https://ravelation.net");
         detailedText(wrappedRavel.lastError());
       }
     if (minsky().model->findAny(&GroupItems::items, [](const ItemPtr& i){return i->ravelCast();}))
       return; // early return if at least 1 ravel already present
     m_editorMode=true; // first ravel is in editor mode
     // set an intial 3 axis ravel to give an indication of what it is about
     wrappedRavel.addHandle("Year",{"1990","1991","1992"});
     wrappedRavel.addHandle("Gender",{"Male","Female"});
     wrappedRavel.addHandle("Country",{"Australia","UK","USA"});
     wrappedRavel.setOutputHandleIds({0,2});
   }

Here is the call graph for this function:

◆ Ravel() [2/2]

minsky::Ravel::Ravel ( const Ravel & x )

inline

Definition at line 90 of file ravelWrap.h.

References getState().

                          : ItemT<Ravel, Operation<OperationType::ravel>>(x), popup(*this)  {
       applyState(x.getState());
     }

Here is the call graph for this function:

Member Function Documentation

◆ adjustSlicer()

void minsky::Ravel::adjustSlicer ( int n )

adjust currently selected handle's slicer

Definition at line 239 of file ravelWrap.cc.

References broadcastStateToLockGroup(), resortHandleIfDynamic(), and wrappedRavel.

Referenced by onKeyPress().

   {
     wrappedRavel.adjustSlicer(n);
     resortHandleIfDynamic();
     broadcastStateToLockGroup();
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ allSliceLabels()

vector< string > minsky::Ravel::allSliceLabels ( ) const

returns all slice labels along the selected handle, in specified order

Definition at line 298 of file ravelWrap.cc.

References wrappedRavel.

   {
     return wrappedRavel.allSliceLabels(wrappedRavel.selectedHandle(),ravel::HandleSort::forward);
   }

◆ allSliceLabelsAxis()

vector< string > minsky::Ravel::allSliceLabelsAxis ( int axis ) const

returns all slice labels along an axis(dimension) identified by its number

Definition at line 303 of file ravelWrap.cc.

References minsky::OperationBase::axis, and wrappedRavel.

   {
     return wrappedRavel.allSliceLabels(axis,ravel::HandleSort::forward);
   }  

◆ allSliceLabelsImpl()

std::vector<std::string> minsky::Ravel::allSliceLabelsImpl	(	int	axis,
		ravel::HandleSort::Order
	)		const

private

◆ applyState()

void minsky::Ravel::applyState ( const ravel::RavelState & state )

apply the state to the Ravel, leaving data, slicelabels etc unchanged

Parameters

preservePositions if true, do not rotate handles

Definition at line 534 of file ravelWrap.cc.

References initState, minsky::OperationBase::r, minsky::Item::updateBoundingBox(), and wrappedRavel.

Referenced by collapseAllHandles(), and populateHypercube().

  {
    if (!wrappedRavel) {
      initState=state;
      return;
    }
    auto r=wrappedRavel.radius();
    wrappedRavel.setRavelState(state);
    if (state.radius!=r) // only need to update bounding box if radius changes
      updateBoundingBox();
  }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ broadcastStateToLockGroup()

void minsky::Ravel::broadcastStateToLockGroup ( ) const

Definition at line 569 of file ravelWrap.cc.

References lockGroup.

Referenced by adjustSlicer(), minsky::RavelPopup::mouseOver(), onMouseUp(), and pickSliceLabels().

   {
     if (lockGroup) lockGroup->broadcast(*this);
   }

Here is the caller graph for this function:

◆ CLASSDESC_ACCESS()

minsky::Ravel::CLASSDESC_ACCESS ( Ravel )

◆ collapseAllHandles()

void minsky::Ravel::collapseAllHandles ( bool collapse = true )

collapse all handles (applying nextReduction op where appropriate)

Parameters

collapse if true, uncollapse if false

Definition at line 263 of file ravelWrap.cc.

References applyState(), getState(), minsky::OperationBase::h, m_nextReduction, minsky::minsky(), and minsky::Minsky::requestReset().

   {
     auto state=getState();
     for (auto& h: state.handleStates)
       if (collapse && !h.collapsed)
         {
           h.reductionOp=m_nextReduction;
           h.collapsed=true;
         }
       else if (!collapse && h.collapsed)
         h.collapsed=false;
     applyState(state);
     minsky().requestReset();
   }

Here is the call graph for this function:

◆ description()

string minsky::Ravel::description ( ) const

Definition at line 424 of file ravelWrap.cc.

References handleDescription(), and wrappedRavel.

Referenced by setDescription().

   {
     return handleDescription(wrappedRavel.selectedHandle());
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dimension()

Dimension minsky::Ravel::dimension ( int handle ) const

dimension details associated with handle

Definition at line 345 of file ravelWrap.cc.

References minsky::cminsky(), minsky::OperationBase::dimensions(), minsky::Minsky::dimensions, and handleDescription().

Referenced by setHandleSortOrder().

   {
     Dimension dim;
     auto dimitr=cminsky().dimensions.find(handleDescription(handle));
     if (dimitr!=cminsky().dimensions.end())
       dim=dimitr->second;
     return dim;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ dimensionType() [1/2]

Dimension::Type minsky::Ravel::dimensionType ( ) const

get/set dimension attributes of selected handle, or handle at given index

Definition at line 434 of file ravelWrap.cc.

References selectedHandle().

   {
     return dimensionType(selectedHandle());
   }

Here is the call graph for this function:

◆ dimensionType() [2/2]

Dimension::Type minsky::Ravel::dimensionType ( int handleIndex ) const

get/set dimension attributes of selected handle, or handle at given index

Definition at line 439 of file ravelWrap.cc.

References axisDimensions, minsky::cminsky(), minsky::Minsky::dimensions, and handleDescription().

   {
     auto descr=handleDescription(handleIndex);
     
     if (auto i=axisDimensions.find(descr); i!=axisDimensions.end())
       return i->second.type;
 
     if (auto i=cminsky().dimensions.find(descr); i!=cminsky().dimensions.end())
       return i->second.type;
 
     return Dimension::string;
   }

Here is the call graph for this function:

◆ dimensionUnitsFormat() [1/2]

std::string minsky::Ravel::dimensionUnitsFormat ( ) const

get/set dimension attributes of selected handle, or handle at given index

Definition at line 452 of file ravelWrap.cc.

References selectedHandle().

   {
     return dimensionUnitsFormat(selectedHandle());
   }

Here is the call graph for this function:

◆ dimensionUnitsFormat() [2/2]

std::string minsky::Ravel::dimensionUnitsFormat ( int handleIndex ) const

get/set dimension attributes of selected handle, or handle at given index

Definition at line 457 of file ravelWrap.cc.

References axisDimensions, minsky::cminsky(), minsky::OperationBase::dimensions(), minsky::Minsky::dimensions, and handleDescription().

   {
     auto descr=handleDescription(handleIndex);
     if (descr.empty()) return "";
     auto i=axisDimensions.find(descr);
     if (i!=axisDimensions.end())
       return i->second.units;
     i=cminsky().dimensions.find(descr);
     if (i!=cminsky().dimensions.end())
       return i->second.units;
     return "";
   }

Here is the call graph for this function:

◆ displayDelayedTooltip()

void minsky::Ravel::displayDelayedTooltip	(	float	x,
		float	y
	)

overridevirtual

enable extended tooltip help message appropriate for mouse at (x,y)

Reimplemented from minsky::Item.

Definition at line 547 of file ravelWrap.cc.

References explanation, wrappedRavel, minsky::Item::x(), and minsky::Item::y().

   {
     if (wrappedRavel.rank()==0)
       explanation="load CSV data from\ncontext menu";
     else
       {
         explanation=wrappedRavel.explain(xx-x(),yy-y());
         // line break every 5 words
         int spCnt=0;
         for (auto& c: explanation)
           if (isspace(c) && ++spCnt % 5 == 0)
             c='\n';
       }
   }

Here is the call graph for this function:

◆ displayFilterCaliper()

bool minsky::Ravel::displayFilterCaliper ( ) const

enable/disable calipers on currently selected handle

Definition at line 279 of file ravelWrap.cc.

References minsky::OperationBase::h, and wrappedRavel.

   {
     const int h=wrappedRavel.selectedHandle();
     if (h>=0)
       {
         auto state=wrappedRavel.getHandleState(h);
         return state.displayFilterCaliper;
       }
     return false;
   }

◆ draw()

void minsky::Ravel::draw ( cairo_t * cairo ) const

overridevirtual

draw this item into a cairo context

Reimplemented from minsky::OperationBase.

Definition at line 80 of file ravelWrap.cc.

References minsky::Item::displayTooltip(), minsky::Item::drawPorts(), minsky::BottomRightResizerItem::drawResizeHandles(), minsky::Item::drawSelected(), minsky::drawTriangle(), explanation, flipped, lockGroup, m_editorMode, M_PI, minsky::Item::m_ports, minsky::NoteBase::mouseFocus, minsky::Item::onBorder, minsky::OperationBase::r, minsky::SVGRenderer::render(), minsky::NoteBase::selected, svgRenderer, minsky::NoteBase::tooltip(), wrappedRavel, minsky::Item::x(), minsky::Item::y(), and minsky::Item::zoomFactor().

   {
     const double  z=zoomFactor(), r=m_editorMode? 1.1*z*wrappedRavel.radius(): 30*z;
     if (flipped)
       {
         m_ports[0]->moveTo(x()-1.1*r, y());
         m_ports[1]->moveTo(x()+1.1*r, y());
         drawTriangle(cairo,m_ports[1]->x()-x(),m_ports[1]->y()-y(),{0,0,0,1},M_PI);
       }
     else
       {
         m_ports[0]->moveTo(x()+1.1*r, y());
         m_ports[1]->moveTo(x()-1.1*r, y());
         drawTriangle(cairo,m_ports[1]->x()-x(),m_ports[1]->y()-y(),{0,0,0,1},0);
       }
     if (mouseFocus)
       {
         drawPorts(cairo);
         displayTooltip(cairo,tooltip().empty()? explanation: tooltip());
         // Resize handles always visible on mousefocus. For ticket 92.
         if (m_editorMode) drawResizeHandles(cairo);
       }
     cairo_rectangle(cairo,-r,-r,2*r,2*r);
     cairo_rectangle(cairo,-1.1*r,-1.1*r,2.2*r,2.2*r);
     cairo_stroke_preserve(cairo);
     if (onBorder || lockGroup)
       { // shadow the border when mouse is over it
         const cairo::CairoSave cs(cairo);
         cairo::Colour c{1,1,1,0};
         if (lockGroup)
           c=palette[ lockGroup->colour() % paletteSz ];
         c.r*=0.5; c.g*=0.5; c.b*=0.5;
         c.a=onBorder? 0.5:0.3;
         cairo_set_source_rgba(cairo,c.r,c.g,c.b,c.a);
         cairo_set_fill_rule(cairo,CAIRO_FILL_RULE_EVEN_ODD);
         cairo_fill_preserve(cairo);
       }
     
     cairo_clip(cairo);
 
     {
       const cairo::CairoSave cs(cairo);
       cairo_rectangle(cairo,-r,-r,2*r,2*r);
       cairo_clip(cairo);
       if (m_editorMode)
         {
           cairo_scale(cairo,z,z);
           CairoRenderer cr(cairo);
           wrappedRavel.render(cr);
         }
       else
         {
           cairo_translate(cairo,-r,-r);
           svgRenderer.render(cairo,2*r,2*r);
         }
     }        
     if (selected) drawSelected(cairo);
   }

Here is the call graph for this function:

◆ editorMode()

bool minsky::Ravel::editorMode ( ) const

inlineoverridevirtual

indicate whether icon is in editor mode or icon mode

Reimplemented from minsky::Item.

Definition at line 218 of file ravelWrap.h.

218 {return m_editorMode;}

minsky::Ravel::m_editorMode

bool m_editorMode

indicate whether icon is in editor mode or icon mode

Definition: ravelWrap.h:66

◆ exportAsCSV()

void minsky::Ravel::exportAsCSV	(	const std::string &	filename,
		bool	tabular
	)		const

export the plotted data as a CSV file

Parameters

tabular - if true, the longest dimension is split across columns as a horizontal dimension

Definition at line 497 of file ravelWrap.cc.

References minsky::TensorOpFactory::create(), minsky::OperationType::data, minsky::TensorsFromPort::ev, minsky::VariableValue::exportAsCSV(), minsky::VariableType::flow, minsky::ValueVector::flowVars, hypercube(), minsky::VariableValue::hypercube(), minsky::Item::itemPtrFromThis(), minsky::Item::m_ports, minsky::OperationType::size, minsky::ValueVector::stockVars, minsky::tensorOpFactory, and wrappedRavel.

   {
     if (!m_ports.empty())
       if (auto vv=m_ports[0]->getVariableValue())
         {
           vv->exportAsCSV(filename, wrappedRavel.description(), tabular);
           return;
         }
 
     // if no variable value attached, create one
     VariableValue v(VariableType::flow); v.hypercube(hypercube());
     const TensorsFromPort tp(make_shared<EvalCommon>());
     tp.ev->update(ValueVector::flowVars.data(), ValueVector::flowVars.size(), ValueVector::stockVars.data());
     v=*tensorOpFactory.create(itemPtrFromThis(), tp);
     // TODO: add some comment lines, such as source of data
     v.exportAsCSV(filename, wrappedRavel.description(), tabular);
   }

Here is the call graph for this function:

◆ getState()

ravel::RavelState minsky::Ravel::getState ( ) const

inline

get the current state of the Ravel

Definition at line 206 of file ravelWrap.h.

Referenced by minsky::RavelLockGroup::broadcast(), collapseAllHandles(), minsky::RavelTensor::operator[](), populateHypercube(), Ravel(), and minsky::RavelTensor::setArgument().

206 {return wrappedRavel? wrappedRavel.getRavelState(): initState;}

minsky::Ravel::initState

ravel::RavelState initState

used entirely to defer persisted state data until after first load from a variable ...

Definition: ravelWrap.h:73

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

Here is the caller graph for this function:

◆ handleDescription()

std::string minsky::Ravel::handleDescription ( int handle ) const

inline

return the description field for handle handle.

Definition at line 189 of file ravelWrap.h.

Referenced by description(), dimension(), dimensionType(), dimensionUnitsFormat(), hypercube(), and setDimension().

189 {return wrappedRavel.handleDescription(handle);}

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

Here is the caller graph for this function:

◆ handleNames()

std::vector<std::string> minsky::Ravel::handleNames ( ) const

inline

return all handle names

Definition at line 157 of file ravelWrap.h.

                                              {
       std::vector<std::string> r;
       for (size_t i=0; i<wrappedRavel.numHandles(); ++i)
         r.push_back(wrappedRavel.handleDescription(i));
       return r;
     }

◆ handleSetReduction()

void minsky::Ravel::handleSetReduction	(	int	handle,
		ravel::Op::ReductionOp	op
	)

inline

set the reduction type for handle

Definition at line 132 of file ravelWrap.h.

References minsky::op.

132 {wrappedRavel.handleSetReduction(handle, op);}

minsky::op

Definition: minsky.h:117

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ handleSortableByValue()

bool minsky::Ravel::handleSortableByValue ( ) const

Returns: true if currently selected handle is sortable by value

Definition at line 406 of file ravelWrap.cc.

References wrappedRavel.

   {
     if (wrappedRavel.rank()!=1) return false;
     auto ids=wrappedRavel.outputHandleIds();
     return size_t(wrappedRavel.selectedHandle())==ids[0];
   }

◆ hypercube()

Hypercube minsky::Ravel::hypercube ( ) const

return hypercube corresponding to the current Ravel state

Definition at line 181 of file ravelWrap.cc.

References axisDimensions, minsky::cminsky(), minsky::OperationBase::dimensions(), minsky::Minsky::dimensions, minsky::OperationBase::h, handleDescription(), and wrappedRavel.

Referenced by exportAsCSV().

   {
     auto outHandles=wrappedRavel.outputHandleIds();
     Hypercube hc;
     auto& xv=hc.xvectors;
     for (auto h: outHandles)
       {
         auto labels=wrappedRavel.sliceLabels(h);
         xv.emplace_back(handleDescription(h));
         if (auto dim=axisDimensions.find(xv.back().name);
             dim!=axisDimensions.end())
           xv.back().dimension=dim->second;
         else if (auto dim=cminsky().dimensions.find(xv.back().name);
                  dim!=cminsky().dimensions.end())
           xv.back().dimension=dim->second;
         // else otherwise dimension is a string (default type)
         for (auto& i: labels)
           xv.back().push_back(i);
       }
     return hc;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ inItem()

bool minsky::Ravel::inItem	(	float	x,
		float	y
	)		const

overridevirtual

Returns: true if item internally responds to the mouse, and (x,y) is within editable area

Reimplemented from minsky::Item.

Definition at line 146 of file ravelWrap.cc.

References m_editorMode, minsky::OperationBase::r, wrappedRavel, minsky::Item::x(), minsky::Item::y(), and minsky::Item::zoomFactor().

   {
     if (m_editorMode)
       {
         const float r=1.1*zoomFactor()*wrappedRavel.radius();
         return std::abs(xx-x())<=r && std::abs(yy-y())<=r;
       }
     return false;
   }

Here is the call graph for this function:

◆ joinLockGroup()

void minsky::Ravel::joinLockGroup ( unsigned colour )

Definition at line 585 of file ravelWrap.cc.

References minsky::cminsky(), minsky::Item::itemPtrFromThis(), minsky::GroupItems::items, leaveLockGroup(), lockGroup, minsky::Minsky::model, and minsky::OperationType::ravel.

   {
     cminsky().model->recursiveDo(&GroupItems::items, [this,colour](Items&, Items::iterator i) {
       if (auto ravel=(*i)->ravelCast(); ravel && ravel->lockGroup && ravel->lockGroup->colour()==colour)
         {
           leaveLockGroup();
           auto ravelPtr=dynamic_pointer_cast<Ravel>(itemPtrFromThis());
           if (ravelPtr)
             {
               lockGroup=ravel->lockGroup;
               lockGroup->addRavel(ravelPtr);
               return true;
             }
         }
       return false;
     });
   }

Here is the call graph for this function:

◆ leaveLockGroup()

void minsky::Ravel::leaveLockGroup ( )

Definition at line 562 of file ravelWrap.cc.

References lockGroup.

Referenced by joinLockGroup().

   {
     if (lockGroup)
       lockGroup->removeFromGroup(*this);
     lockGroup.reset();
   }

Here is the caller graph for this function:

◆ lockGroupColours()

vector< unsigned > minsky::Ravel::lockGroupColours ( )

static

Definition at line 574 of file ravelWrap.cc.

References minsky::cminsky(), minsky::GroupItems::items, minsky::Minsky::model, minsky::OperationBase::r, and minsky::OperationType::ravel.

   {
     set<unsigned> r;
     cminsky().model->recursiveDo(&GroupItems::items, [&r](Items&, Items::iterator i) {
       if (auto ravel=(*i)->ravelCast(); ravel && ravel->lockGroup)
         r.insert(ravel->lockGroup->colour());
       return false;
     });
     return {r.begin(),r.end()};
   }

Here is the call graph for this function:

◆ maxRank()

unsigned minsky::Ravel::maxRank ( ) const

inline

Returns: input rank (aka numHandles)

Definition at line 119 of file ravelWrap.h.

119 {return wrappedRavel.numHandles();}

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ nextReduction()

void minsky::Ravel::nextReduction ( ravel::Op::ReductionOp op )

inline

sets the type of the next reduction operation

Definition at line 130 of file ravelWrap.h.

References minsky::op.

130 {m_nextReduction=op; wrappedRavel.nextReduction(op);}

minsky::op

Definition: minsky.h:117

minsky::Ravel::m_nextReduction

ravel::Op::ReductionOp m_nextReduction

Definition: ravelWrap.h:81

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ numHandles()

unsigned minsky::Ravel::numHandles ( ) const

inline

Definition at line 120 of file ravelWrap.h.

Referenced by pickSliceLabels(), and units().

120 {return wrappedRavel.numHandles();}

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

Here is the caller graph for this function:

◆ numSliceLabels()

size_t minsky::Ravel::numSliceLabels ( size_t axis ) const

inline

number of slice labels along axis axis

Definition at line 122 of file ravelWrap.h.

Referenced by populateHypercube(), and units().

122 {return wrappedRavel.numSliceLabels(axis);}

minsky::OperationBase::axis

std::string axis

axis selector in tensor operations

Definition: operationBase.h:90

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

Here is the caller graph for this function:

◆ onKeyPress()

bool minsky::Ravel::onKeyPress	(	int	keySym,
		const std::string &	utf8,
		int	state
	)

overridevirtual

respond to key press events

Returns: true if it needs to be rerendered

Reimplemented from minsky::Item.

Definition at line 246 of file ravelWrap.cc.

References adjustSlicer(), minsky::minsky(), and minsky::Minsky::requestReset().

Referenced by minsky::RavelPopup::keyPress().

   {
     switch (keySym)
       {
       case 0xff52: case 0xff53: //Right, Up
         adjustSlicer(1);
         break;
       case 0xff51: case 0xff54: //Left, Down
         adjustSlicer(-1);
         break;
       default:
         return false;
       }
     minsky().requestReset();
     return true;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ onMouseDown()

void minsky::Ravel::onMouseDown	(	float	x,
		float	y
	)

overridevirtual

respond to mouse down events

Reimplemented from minsky::Item.

Definition at line 156 of file ravelWrap.cc.

References wrappedRavel, minsky::Item::x(), minsky::Item::y(), and minsky::Item::zoomFactor().

   {
     const double invZ=1/zoomFactor();
     wrappedRavel.onMouseDown((xx-x())*invZ,(yy-y())*invZ);
   }

Here is the call graph for this function:

◆ onMouseLeave()

void minsky::Ravel::onMouseLeave ( )

inlineoverridevirtual

respond to mouse leave events (when mouse leaves item)

Reimplemented from minsky::Item.

Definition at line 114 of file ravelWrap.h.

114 {wrappedRavel.onMouseLeave();}

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ onMouseMotion()

bool minsky::Ravel::onMouseMotion	(	float	x,
		float	y
	)

overridevirtual

respond to mouse motion events with button pressed

Returns: true if it needs to be rerendered

Reimplemented from minsky::Item.

Definition at line 169 of file ravelWrap.cc.

References wrappedRavel, minsky::Item::x(), minsky::Item::y(), and minsky::Item::zoomFactor().

   {
     const double invZ=1/zoomFactor();
     return wrappedRavel.onMouseMotion((xx-x())*invZ,(yy-y())*invZ);
   }

Here is the call graph for this function:

◆ onMouseOver()

bool minsky::Ravel::onMouseOver	(	float	x,
		float	y
	)

overridevirtual

respond to mouse motion events (hover) without button pressed

Returns: true if it needs to be rerendered

Reimplemented from minsky::Item.

Definition at line 175 of file ravelWrap.cc.

References wrappedRavel, minsky::Item::x(), minsky::Item::y(), and minsky::Item::zoomFactor().

   {
     const double invZ=1/zoomFactor();
     return wrappedRavel.onMouseOver((xx-x())*invZ,(yy-y())*invZ);
   }

Here is the call graph for this function:

◆ onMouseUp()

void minsky::Ravel::onMouseUp	(	float	x,
		float	y
	)

overridevirtual

respond to mouse up events

Reimplemented from minsky::Item.

Definition at line 162 of file ravelWrap.cc.

References broadcastStateToLockGroup(), resortHandleIfDynamic(), wrappedRavel, minsky::Item::x(), minsky::Item::y(), and minsky::Item::zoomFactor().

   {
     const double invZ=1/zoomFactor();
     wrappedRavel.onMouseUp((xx-x())*invZ,(yy-y())*invZ);
     resortHandleIfDynamic();
     broadcastStateToLockGroup();
   }

Here is the call graph for this function:

◆ operator=()

void minsky::Ravel::operator= ( const Ravel & )

inline

Definition at line 89 of file ravelWrap.h.

89 {}

◆ pickedSliceLabels() [1/2]

vector< string > minsky::Ravel::pickedSliceLabels ( ) const

returns just the picked slice labels along the handle

Definition at line 311 of file ravelWrap.cc.

References wrappedRavel.

312 {return pickedSliceLabels(wrappedRavel.selectedHandle());}

minsky::Ravel::pickedSliceLabels

std::vector< std::string > pickedSliceLabels() const

returns just the picked slice labels along the handle

Definition: ravelWrap.cc:311

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ pickedSliceLabels() [2/2]

vector< string > minsky::Ravel::pickedSliceLabels ( int axis ) const

Definition at line 308 of file ravelWrap.cc.

References minsky::OperationBase::axis, and wrappedRavel.

309 {return wrappedRavel.sliceLabels(axis);}

minsky::OperationBase::axis

std::string axis

axis selector in tensor operations

Definition: operationBase.h:90

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ pickSliceLabels()

void minsky::Ravel::pickSliceLabels	(	int	axis,
		const std::vector< std::string > &	pick
	)

pick (selected) pick labels

Definition at line 314 of file ravelWrap.cc.

References minsky::OperationBase::axis, broadcastStateToLockGroup(), minsky::minsky(), numHandles(), minsky::Minsky::requestReset(), and wrappedRavel.

   {
     if (axis>=0 && axis<int(numHandles()))
       {
         vector<size_t> customOrder, currentOrder=wrappedRavel.currentPermutation(axis);
         auto allLabels=wrappedRavel.allSliceLabels(axis, ravel::HandleSort::none);
         map<string,size_t> idxMap; // map index positions
         for (size_t i=0; i<allLabels.size(); ++i)
           idxMap[allLabels[i]]=i;
         set<string> picked(pick.begin(), pick.end());
         for (auto i: currentOrder)
           {
             auto pickedIter=picked.find(allLabels[i]);
             if (pickedIter==picked.end()) continue;
             picked.erase(pickedIter);
             customOrder.push_back(i);
           }
         // add remaining picked labels to end of permutation
         for (auto& i: picked)
           {
             auto j=idxMap.find(i);
             if (j!=idxMap.end())
               customOrder.push_back(j->second);
           }
         assert(!customOrder.empty());
         wrappedRavel.applyCustomPermutation(axis,customOrder);
         broadcastStateToLockGroup();
         minsky().requestReset();
       }
   }

Here is the call graph for this function:

◆ populateHypercube()

void minsky::Ravel::populateHypercube ( const Hypercube & hc )

Definition at line 203 of file ravelWrap.cc.

References applyState(), getState(), initState, numSliceLabels(), setRank(), and wrappedRavel.

   {
     if (!wrappedRavel) return;
     auto state=initState.empty()? getState(): initState;
     const bool redistribute=!initState.empty();
     initState.clear();
     wrappedRavel.populateFromHypercube(hc);
     if (state.empty())
       {
         setRank(hc.rank());
       }
     else
       {
         applyState(state);
         if (redistribute) wrappedRavel.redistributeHandles();
       }
 #ifndef NDEBUG
     if (wrappedRavel && state.empty())
       {
         auto d=hc.dims();
         assert(d.size()==wrappedRavel.rank());
         auto outputHandles=wrappedRavel.outputHandleIds();
         for (size_t i=0; i<d.size(); ++i)
           assert(d[i]==numSliceLabels(outputHandles[i]));
       }
 #endif
   }

Here is the call graph for this function:

◆ radius()

double minsky::Ravel::radius ( ) const

inline

Definition at line 97 of file ravelWrap.h.

97 {return wrappedRavel.radius();}

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ ravelCast() [1/2]

const Ravel* minsky::Ravel::ravelCast ( ) const

inlineoverride

Definition at line 94 of file ravelWrap.h.

94 {return this;}

◆ ravelCast() [2/2]

Ravel* minsky::Ravel::ravelCast ( )

inlineoverride

Definition at line 95 of file ravelWrap.h.

95 {return this;}

◆ redistributeHandles()

void minsky::Ravel::redistributeHandles ( )

inline

redistribute handles according to current state

Definition at line 128 of file ravelWrap.h.

128 {wrappedRavel.redistributeHandles();}

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ resize()

void minsky::Ravel::resize ( const LassoBox & b )

overridevirtual

resize this item on the canvas

Reimplemented from minsky::OperationBase.

Definition at line 139 of file ravelWrap.cc.

References minsky::Item::bb, minsky::Item::moveTo(), minsky::BoundingBox::update(), wrappedRavel, minsky::LassoBox::x0, minsky::LassoBox::x1, minsky::LassoBox::y0, minsky::LassoBox::y1, and minsky::Item::zoomFactor().

   {
     wrappedRavel.rescale(0.5*std::max(fabs(b.x0-b.x1),fabs(b.y0-b.y1))/(1.21*zoomFactor()));
     moveTo(0.5*(b.x0+b.x1), 0.5*(b.y0+b.y1));
     bb.update(*this);
   }

Here is the call graph for this function:

◆ resortHandleIfDynamic()

void minsky::Ravel::resortHandleIfDynamic ( )

Definition at line 371 of file ravelWrap.cc.

References sortByValue(), and wrappedRavel.

Referenced by adjustSlicer(), and onMouseUp().

   {
     if (wrappedRavel.rank()==1)
       {
         const int outputHandleId=wrappedRavel.outputHandleIds()[0];
         auto hs=wrappedRavel.getHandleState(outputHandleId);
         switch (hs.order)
           {
           case ravel::HandleSort::dynamicForward:
           case ravel::HandleSort::dynamicReverse:
             {
               auto calipers=wrappedRavel.getCaliperPositions(outputHandleId);
               // sortByValue of the whole range of the dimension
               wrappedRavel.displayFilterCaliper(outputHandleId,false);
               sortByValue(hs.order);
               wrappedRavel.displayFilterCaliper(outputHandleId,hs.displayFilterCaliper);
               wrappedRavel.setCaliperPositions(outputHandleId,calipers.first,calipers.second);
             }
             break;
           default:
             break;
           }
       }
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ selectedHandle()

int minsky::Ravel::selectedHandle ( ) const

inline

current handle mouse is over, or -1 if none

Definition at line 134 of file ravelWrap.h.

Referenced by dimensionType(), dimensionUnitsFormat(), and setDimension().

134 {return wrappedRavel.selectedHandle();}

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

Here is the caller graph for this function:

◆ setDescription()

void minsky::Ravel::setDescription ( const std::string & description )

Definition at line 429 of file ravelWrap.cc.

References description(), and wrappedRavel.

   {
     wrappedRavel.setHandleDescription(wrappedRavel.selectedHandle(),description);
   }

Here is the call graph for this function:

◆ setDimension() [1/2]

void minsky::Ravel::setDimension	(	Dimension::Type	type,
		const std::string &	units
	)

Exceptions

if	type does not match global dimension type

Definition at line 471 of file ravelWrap.cc.

References selectedHandle(), minsky::Operation< OperationType::ravel >::type(), and units().

   {
     return setDimension(selectedHandle(), type, units);
   }

Here is the call graph for this function:

◆ setDimension() [2/2]

void minsky::Ravel::setDimension	(	int	handleIndex,
		Dimension::Type	type,
		const std::string &	units
	)

Exceptions

if	type does not match global dimension type

Definition at line 477 of file ravelWrap.cc.

References axisDimensions, minsky::cminsky(), minsky::OperationBase::dimensions(), minsky::Minsky::dimensions, handleDescription(), minsky::Minsky::imposeDimensions(), minsky::minsky(), minsky::Operation< OperationType::ravel >::type(), and units().

   {
     auto descr=handleDescription(handleIndex);
     if (descr.empty()) return;
     auto i=cminsky().dimensions.find(descr);
     const Dimension d{type,units};
     if (i!=cminsky().dimensions.end())
       {
         if (type!=i->second.type)
           throw error("type mismatch with global dimension");
       }
     else
       {
         minsky().dimensions[descr]=d;
         minsky().imposeDimensions();
       }
     axisDimensions[descr]=d;
   }

Here is the call graph for this function:

◆ setDisplayFilterCaliper()

bool minsky::Ravel::setDisplayFilterCaliper ( bool x )

Definition at line 290 of file ravelWrap.cc.

References minsky::OperationBase::h, wrappedRavel, and minsky::Item::x().

   {
     const int h=wrappedRavel.selectedHandle();
     if (h>=0)
       wrappedRavel.displayFilterCaliper(h,x);
     return x;
   }

Here is the call graph for this function:

◆ setHandleDescription()

void minsky::Ravel::setHandleDescription	(	int	handle,
		const std::string &	description
	)

inline

set the description field for handle

Definition at line 191 of file ravelWrap.h.

192 {wrappedRavel.setHandleDescription(handle,description);}

minsky::Ravel::description

std::string description() const

Definition: ravelWrap.cc:424

minsky::Ravel::wrappedRavel

ravelCAPI::Ravel wrappedRavel

Definition: ravelWrap.h:80

◆ setHandleSortOrder()

ravel::HandleSort::Order minsky::Ravel::setHandleSortOrder	(	ravel::HandleSort::Order	order,
		int	handle
	)

set a given handle sort order

Definition at line 396 of file ravelWrap.cc.

References dimension(), and wrappedRavel.

Referenced by setSortOrder().

   {
     if (handle>=0)
       {
         const Dimension dim=dimension(handle);
         wrappedRavel.orderLabels(handle,order);
       }
     return order;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ setRank()

void minsky::Ravel::setRank ( unsigned r )

adjust output dimensions to first r handles

Definition at line 232 of file ravelWrap.cc.

References wrappedRavel.

Referenced by populateHypercube().

   {
     vector<size_t> ids;
     for (size_t i=0; i<rank; ++i) ids.push_back(i);
     wrappedRavel.setOutputHandleIds(ids);
   }

Here is the caller graph for this function:

◆ setSortOrder()

ravel::HandleSort::Order minsky::Ravel::setSortOrder ( ravel::HandleSort::Order x )

the handle sorting order for currently selected handle

Definition at line 365 of file ravelWrap.cc.

References setHandleSortOrder(), wrappedRavel, and minsky::Item::x().

   {
     setHandleSortOrder(x, wrappedRavel.selectedHandle());
     return x;
   }

Here is the call graph for this function:

◆ sortByValue()

void minsky::Ravel::sortByValue ( ravel::HandleSort::Order dir )

Sort handle by value. Only applicable for rank 1 ravels.

Parameters

dir	direction to sort (forward/reverse, all other cases ignored)

Definition at line 413 of file ravelWrap.cc.

References minsky::Item::m_ports, minsky::minsky(), minsky::Minsky::requestReset(), and wrappedRavel.

Referenced by resortHandleIfDynamic().

   {
     if (wrappedRavel.rank()!=1) return;
     try {minsky().requestReset();} catch (...) {throw runtime_error("Cannot sort handle at the moment");}
     auto vv=m_ports[1]->getVariableValue();
     if (!vv)
       throw runtime_error("Cannot sort handle at the moment");
     wrappedRavel.sortByValue(vv, dir);
   }

Here is the call graph for this function:

Here is the caller graph for this function:

◆ sortOrder()

ravel::HandleSort::Order minsky::Ravel::sortOrder ( ) const

the handle sorting order for currently selected handle

Definition at line 354 of file ravelWrap.cc.

References minsky::OperationBase::h, and wrappedRavel.

   {
     const int h=wrappedRavel.selectedHandle();
     if (h>=0)
       {
         auto state=wrappedRavel.getHandleState(h);
         return state.order;
       }
     return ravel::HandleSort::none;
   }

◆ toggleDisplayFilterCaliper()

bool minsky::Ravel::toggleDisplayFilterCaliper ( )

inline

Definition at line 142 of file ravelWrap.h.

143 {return setDisplayFilterCaliper(!displayFilterCaliper());}

minsky::Ravel::displayFilterCaliper

bool displayFilterCaliper() const

enable/disable calipers on currently selected handle

Definition: ravelWrap.cc:279

minsky::Ravel::setDisplayFilterCaliper

bool setDisplayFilterCaliper(bool x)

Definition: ravelWrap.cc:290

◆ toggleEditorMode()

void minsky::Ravel::toggleEditorMode ( )

inlineoverridevirtual

Reimplemented from minsky::Item.

Definition at line 219 of file ravelWrap.h.

219 {m_editorMode=!m_editorMode;updateBoundingBox();}

minsky::Ravel::m_editorMode

bool m_editorMode

indicate whether icon is in editor mode or icon mode

Definition: ravelWrap.h:66

minsky::Item::updateBoundingBox

void updateBoundingBox() override

Definition: item.h:198

◆ units()

Units minsky::Ravel::units ( bool check ) const

overridevirtual

compute the dimensional units

Parameters

check - if true, then perform consistency checks

Exceptions

if	check=true and dimensions inconsistent

Reimplemented from minsky::OperationBase.

Definition at line 515 of file ravelWrap.cc.

References minsky::OperationBase::h, minsky::Item::m_ports, numHandles(), numSliceLabels(), and wrappedRavel.

Referenced by setDimension().

   {
     Units inputUnits=m_ports[1]->units(check);
     if (inputUnits.empty()) return inputUnits;
     size_t multiplier=1;
     // at this stage, gross up exponents by the handle size of each
     // reduced by product handles
     for (size_t h=0; h<numHandles(); ++h)
       {
         auto state=wrappedRavel.getHandleState(h);
         if (state.collapsed && state.reductionOp==ravel::Op::prod)
           multiplier*=numSliceLabels(h);
       }
     if (multiplier>1)
       for (auto& u: inputUnits)
         u.second*=multiplier;
     return inputUnits;
   }

Here is the call graph for this function:

Here is the caller graph for this function:

Friends And Related Function Documentation

◆ SchemaHelper

friend struct SchemaHelper

friend

Definition at line 75 of file ravelWrap.h.

Member Data Documentation

◆ axisDimensions

Dimensions minsky::Ravel::axisDimensions

local override of axis dimensionality

Definition at line 100 of file ravelWrap.h.

Referenced by dimensionType(), dimensionUnitsFormat(), hypercube(), and setDimension().

◆ explanation

std::string minsky::Ravel::explanation

private

Definition at line 68 of file ravelWrap.h.

Referenced by displayDelayedTooltip(), and draw().

◆ flipped

bool minsky::Ravel::flipped =false

Definition at line 85 of file ravelWrap.h.

Referenced by draw().

◆ initState

ravel::RavelState minsky::Ravel::initState

private

used entirely to defer persisted state data until after first load from a variable

Definition at line 73 of file ravelWrap.h.

Referenced by applyState(), minsky::SchemaHelper::initHandleState(), and populateHypercube().

◆ lockGroup

std::shared_ptr<RavelLockGroup> minsky::Ravel::lockGroup

group of ravels that move syncronously

Definition at line 103 of file ravelWrap.h.

Referenced by broadcastStateToLockGroup(), draw(), joinLockGroup(), and leaveLockGroup().

◆ m_editorMode

bool minsky::Ravel::m_editorMode =false

private

indicate whether icon is in editor mode or icon mode

Definition at line 66 of file ravelWrap.h.

Referenced by draw(), inItem(), and Ravel().

◆ m_nextReduction

ravel::Op::ReductionOp minsky::Ravel::m_nextReduction =ravel::Op::sum

private

Definition at line 81 of file ravelWrap.h.

Referenced by collapseAllHandles().

◆ moveSz

const double minsky::Ravel::moveSz =0.1

private

Definition at line 63 of file ravelWrap.h.

◆ moveX

const double minsky::Ravel::moveX =0.5

private

position of the "move" handle, as a proportion of radius

Definition at line 63 of file ravelWrap.h.

◆ moveY

const double minsky::Ravel::moveY =0.5

private

Definition at line 63 of file ravelWrap.h.

◆ popup

RavelPopup minsky::Ravel::popup

popup Ravel control window

Definition at line 84 of file ravelWrap.h.

◆ previousOrder

ravel::HandleSort::Order minsky::Ravel::previousOrder =ravel::HandleSort::forward

private

Definition at line 69 of file ravelWrap.h.

◆ RavelPopup

friend minsky::Ravel::RavelPopup

private

Definition at line 76 of file ravelWrap.h.

◆ svgRenderer

SVGRenderer minsky::Ravel::svgRenderer

static

SVG icon to display when not in editor mode.

Definition at line 83 of file ravelWrap.h.

Referenced by draw(), and minsky::Minsky::setRavelIconResource().

◆ wrappedRavel

ravelCAPI::Ravel minsky::Ravel::wrappedRavel

private

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

model/ravelWrap.h
model/ravelWrap.cc

Public Member Functions

Static Public Member Functions

Public Attributes

Static Public Attributes

Private Types

Private Member Functions

Private Attributes

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ HandleState

Constructor & Destructor Documentation

◆ Ravel() [1/2]

◆ Ravel() [2/2]

Member Function Documentation

◆ adjustSlicer()

◆ allSliceLabels()

◆ allSliceLabelsAxis()

◆ allSliceLabelsImpl()

◆ applyState()

◆ broadcastStateToLockGroup()

◆ CLASSDESC_ACCESS()

◆ collapseAllHandles()

◆ description()

◆ dimension()

◆ dimensionType() [1/2]

◆ dimensionType() [2/2]

◆ dimensionUnitsFormat() [1/2]

◆ dimensionUnitsFormat() [2/2]

◆ displayDelayedTooltip()

◆ displayFilterCaliper()

◆ draw()

◆ editorMode()

◆ exportAsCSV()

◆ getState()

◆ handleDescription()

◆ handleNames()

◆ handleSetReduction()

◆ handleSortableByValue()

◆ hypercube()

◆ inItem()

◆ joinLockGroup()

◆ leaveLockGroup()

◆ lockGroupColours()

◆ maxRank()

◆ nextReduction()

◆ numHandles()

◆ numSliceLabels()

◆ onKeyPress()

◆ onMouseDown()

◆ onMouseLeave()

◆ onMouseMotion()

◆ onMouseOver()

◆ onMouseUp()

◆ operator=()

◆ pickedSliceLabels() [1/2]

◆ pickedSliceLabels() [2/2]

◆ pickSliceLabels()

◆ populateHypercube()

◆ radius()

◆ ravelCast() [1/2]

◆ ravelCast() [2/2]

◆ redistributeHandles()

◆ resize()

◆ resortHandleIfDynamic()

◆ selectedHandle()

◆ setDescription()

◆ setDimension() [1/2]

◆ setDimension() [2/2]

◆ setDisplayFilterCaliper()

◆ setHandleDescription()

◆ setHandleSortOrder()

◆ setRank()

◆ setSortOrder()

◆ sortByValue()

◆ sortOrder()

◆ toggleDisplayFilterCaliper()

◆ toggleEditorMode()

◆ units()